Canarytokens

by Thinkst Applied Research

개요

Canarytokens는 네트워크에서의 활동과 행위를 추적하는 데 도움을 줍니다.

문제가 있으시면 여기에서 FAQ를 확인하시거나, 이슈를 생성해 주시면 최대한 빠르게 답변드리겠습니다.

행동 강령

이 프로젝트와 이에 참여하는 모든 사람은 행동 강령의 적용을 받습니다. 참여함으로써 귀하는 이 강령을 준수할 것으로 기대됩니다. 용납할 수 없는 행동은 [email protected]으로 신고해 주시기 바랍니다.

지원 중단

Slack API Token은 지원 중단되었으며 더 이상 새로 생성할 수 없습니다. 기존 토큰은 계속 작동합니다.

설치

Docker 이미지 설치 과정을 권장합니다.

구성

Canarytokens 서버는 다양한 설정 구성을 사용할 수 있습니다. 이는 settings.py에서 확인할 수 있습니다. 두 가지 주요 설정 파일이 있습니다: frontend.env와 switchboard.env.

frontend.env에는 다음과 같은 프런트엔드 프로세스 설정이 포함됩니다:

CANARY_DOMAINS=mytesttokensdomain.com
CANARY_NXDOMAINS=pdf.demo.canarytokens.net
CANARY_AWSID_URL=
CANARY_AWSID_AUTH=
CANARY_AWSID_GUID=
CANARY_AWSID_CONTROL_ACCOUNT_ID=
CANARY_WEB_IMAGE_UPLOAD_PATH=/uploads
CANARY_GOOGLE_API_KEY=
LOG_FILE=frontend.log

switchboard.env에는 다음과 같은 스위치보드 프로세스 설정이 포함됩니다:

Variable Name	Value
CANARY_MAILGUN_DOMAIN_NAME
CANARY_MAILGUN_API_KEY
CANARY_MANDRILL_API_KEY
CANARY_SENDGRID_API_KEY
CANARY_PUBLIC_IP
CANARY_PUBLIC_DOMAIN
CANARY_ALERT_EMAIL_FROM_ADDRESS	[email protected]
CANARY_ALERT_EMAIL_FROM_DISPLAY	"Canarytoken Mailer"
CANARY_ALERT_EMAIL_SUBJECT	"Alert"
CANARY_MAX_ALERTS_PER_MINUTE	1000
CANARY_SMTP_USERNAME
CANARY_SMTP_PASSWORD
CANARY_SMTP_SERVER	smtp.gmail.com
CANARY_IPINFO_API_KEY	<ipinfo.io api key>
CANARY_SMTP_PORT	587
CANARY_WEB_IMAGE_UPLOAD_PATH	/uploads
LOG_FILE	switchboard.log
ERROR_LOG_WEBHOOK
CANARY_FORCE_HTTPS	force `https` protocol scheme for Canarytokens
CANARY_LAMBDA_AWS_CRED_REPORT_AUTH

사용할 이메일 제공자를 선택할 때, 해당 제공자와 관련된 정보만 반드시 제공해야 합니다. 예를 들어 CANARY_MAILGUN_API_KEY가 있다면 CANARY_SENDGRID_API_KEY와 CANARY_MANDRILL_API_KEY 같은 다른 항목은 제거해야 합니다.

Canarytokens 서버에 Mailgun의 유럽 인프라를 사용하는 경우, switchboard.env에 CANARY_MAILGUN_BASE_URL=https://api.eu.mailgun.net을 추가해야 합니다. 이를 지정하지 않으면 기본값으로 'https://api.mailgun.net'의 일반 URL을 사용합니다.

AWS ID 인프라

AWS API 키 Canarytokens는 AWS 측 인프라를 사용하여 IAM 사용자를 할당하고 안전망 검사를 실행합니다. 해당 인프라는 비공개 저장소로 이전되었습니다.

이 저장소는 여전히 Canarytokens와 관련된 통합 지점을 관리합니다:

frontend.env의 CANARY_AWSID_URL은 비공개 저장소에서 관리되는 LinkAWSIDTokenUserToCanaryConsole 엔드포인트의 API Gateway/Lambda URL입니다.
frontend.env의 CANARY_AWSID_AUTH는 AWS ID 시크릿의 인증 토큰과 일치해야 합니다. 프런트엔드는 AWS 키 토큰을 생성할 때 domain, token, auth, guid를 전송합니다.
CANARY_AWSID_GUID는 AWS 키 토큰을 할당하고 삭제할 때 Canarytokens 인스턴스를 식별합니다.
CANARY_AWSID_CONTROL_ACCOUNT_ID는 AWS ID 삭제 큐를 소유한 AWS 계정 ID입니다.
CANARY_AWSID_URL 또는 CANARY_AWSID_AUTH 중 하나라도 설정되지 않으면, 이 Canarytokens 인스턴스에 대해 AWS 키 토큰 생성이 비활성화됩니다.
switchboard.env의 CANARY_LAMBDA_AWS_CRED_REPORT_AUTH는 AWS ID 자격 증명 보고서 검사기에서 사용하는 /a/cr 콜백을 활성화합니다.

발신 SMTP 구성

발신 SMTP를 구성할 때 다음 사항을 고려하시기 바랍니다:

제한 사항:

작동하려면 Mailgun이나 Sendgrid 같은 다른 제공자가 구성되어 있지 않아야 합니다
AWS SES의 경우 CANARY_ALERT_EMAIL_FROM_DISPLAY는 CANARY_ALERT_EMAIL_FROM_DISPLAY=CanaryAlert <[email protected]> 형식이어야 합니다

참고: SMTP 알림 이메일은 RFC를 준수하는 From 헤더를 전송합니다. CANARY_ALERT_EMAIL_FROM_DISPLAY가 표시 이름으로 구성된 경우, 결과 헤더는 Display Name <CANARY_ALERT_EMAIL_FROM_ADDRESS>로 렌더링되어 기존 Mailgun 동작과 일치합니다. 이로 인해 SMTP 기반 배포에서 메일 클라이언트에 표시되는 발신자가 약간 변경될 수 있지만, 알림 이메일 본문은 변경되지 않습니다.

SMTP가 작동하려면 switchboard.env에 다음 설정을 구성해야 합니다:

CANARY_SMTP_SERVER: SMTP 서버
CANARY_SMTP_PORT: SMTP 서버의 포트 번호 (StartTLS가 활성화된 포트여야 합니다!)
CANARY_SMTP_USERNAME: SMTP 서버의 사용자 이름 (현재 익명 SMTP는 지원되지 않습니다)
CANARY_SMTP_PASSWORD: 사용자 이름에 해당하는 비밀번호

switchboard.env의 전체 예시 구성은 다음과 같습니다:

CANARY_SMTP_SERVER=smtp.yourserver.com
CANARY_SMTP_PORT=587
CANARY_SMTP_USERNAME=<your smtp username>
CANARY_SMTP_PASSWORD=<your smtp password>
[email protected]
CANARY_ALERT_EMAIL_SUBJECT="Canary Alert via SMTP"

알림 스로틀링

기본적으로 DEBUG 모드로 실행되지 않는 한, 고유한 호출 IP당 분당 1개를 초과하는 알림은 허용되지 않습니다. 활동은 여전히 데이터베이스에 기록되고 토큰 관리 콘솔에 표시되지만, 알림(이메일 및/또는 웹훅)은 생성되지 않습니다.

이는 스위치보드 ENV 변수 CANARY_MAX_ALERTS_PER_MINUTE로 조정할 수 있습니다.

웹훅 실패 제한

웹훅이 연속으로 5번 오류를 반환하면 비활성화됩니다. 이 동작은 MAX_ALERT_FAILURES로 조정할 수 있습니다.

FAQ

여기에 FAQ가 있습니다

기여

풀 리퀘스트를 제출하기 전에 행동 강령과 기여 문서를 확인해 주시기 바랍니다.

귀하의 소중한 기여를 기다리겠습니다.

canarytokens

인기