我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

关于密码扫描

GitHub 扫描仓库查找已知的密码类型,以防止欺诈性使用意外提交的密码。

秘密扫描 可用于公共仓库,以及具有 Advanced Security 许可的组织拥有的私有仓库。 更多信息请参阅“关于 GitHub Advanced Security”。

本文内容

如果项目与外部服务通信,您可能使用令牌或私钥进行身份验证。 令牌和私钥是服务提供商可以签发的典型密码。 如果将密码检入仓库,则对仓库具有读取权限的任何人都可以使用该密码以您的权限访问外部服务。 建议将密码存储在项目仓库外部专用的安全位置。

服务提供商可与 GitHub 合作提供其用于扫描的密码格式。 更多信息请参阅“密码扫描”。

如果有人将密码从 GitHub 合作伙伴检入 GitHub 上的公共或私有仓库,则 秘密扫描 在该密码检入时可以捕获它,帮助您减小密码泄露的影响。 仓库管理员会收到包含密码的任何提交的通知, 然后他们可以快速查看仓库安全选项卡中所有检测到的密码。

关于公共仓库的 秘密扫描

秘密扫描 自动对公共仓库启用。 当您推送到公共仓库时,GitHub 会扫描提交的内容中是否有密码。 如果将私有仓库切换到公共仓库,GitHub 会扫描整个仓库中的密码。

当 秘密扫描 检测一组凭据时,我们会通知发布密码的服务提供商。 服务提供商会验证该凭据,然后决定是否应撤销密钥、颁发新密钥或直接与您联系,具体取决于与您或服务提供商相关的风险。 有关如何使用令牌颁发合作伙伴的概述,请参阅“密码扫描”。

GitHub 当前会扫描公共仓库,查找以下服务提供商发布的密码。

合作伙伴支持的密钥
Adafruit IOAdafruit IO 密钥
Alibaba CloudAlibaba 云端访问密钥 ID 和访问密钥对
Amazon Web Services (AWS)Amazon AWS 访问密钥 ID 和秘密访问密钥对
AtlassianAtlassian API 令牌
AtlassianAtlassian JSON Web 令牌
AzureAzure DevOps 个人访问令牌
AzureAzure SAS Token
AzureAzure 服务管理证书
AzureAzure SQL 连接字符串
AzureAzure 存储帐户密钥
ClojarsClojars 部署令牌
CloudBees CodeShipCloudBees CodeShip 凭据
DatabricksDatabricks 访问令牌
DatadogDatadog API 密钥
DiscordDiscord 自动程序令牌
DopplerDoppler 个人令牌
DopplerDoppler 服务令牌
DopplerDoppler CLI 令牌
DopplerDoppler SCIM 令牌
DropboxDropbox 访问令牌
DropboxDropbox 短暂访问令牌
DynatraceDynatrace 访问令牌
DynatraceDynatrace 内部令牌
FinicityFinicity App 密钥
Frame.ioFrame.io JSON Web 令牌
Frame.ioFrame.io Developer 令牌
GitHubGitHub SSH 私钥
GitHubGitHub 个人访问令牌
GitHubGitHub App 安装访问令牌
GoCardlessGoCardless 实时访问令牌
GoCardlessGoCardless Sandbox 访问令牌
Google CloudGoogle API 密钥
Google CloudGoogle Cloud 私钥 ID
Hashicorp TerraformTerraform Cloud / Enterprise API 令牌
HubspotHubspot API 密钥
MailchimpMailchimp API 密钥
MailchimpMandril API 密钥
MailgunMailgun API 密钥
MessageBirdMessageBird API 密钥
npmnpm 访问令牌
NuGetNuGet API 密钥
PalantirPalantir JSON Web 令牌
PlivoPlivo 验证令牌
PostmanPostman API 密钥
ProctorioProctorio 消费者密钥
ProctorioProctorio 链接密钥
ProctorioProctorio 注册密钥
ProctorioProctorio 密钥
PulumiPulumi 访问令牌
PyPIPyPI API 令牌
RubyGemsRubyGems API 密钥
SamsaraSamsara API 令牌
SamsaraSamsara OAuth 访问令牌
ShopifyShopify App 共享密钥
ShopifyShopify 访问令牌
ShopifyShopify 自定义应用访问令牌
ShopifyShopify 私人应用密码
SlackSlack API 令牌
SlackSlack 传入 web 挂钩 URL
SlackSlack 工作流程 web 挂钩 URL
SSLMateSSLMate API 密钥
SSLMateSSLMate 集群密钥
StripeStripe Live API 密钥
StripeStripe 测试 API 密钥
StripeStripe Live API 限制密钥
StripeStripe 测试 API 限制密钥
Tencent Cloud腾讯云密钥 ID
TwilioTwilio 帐户字符串标识符
TwilioTwilio API 密钥

关于私有仓库的 秘密扫描

如果您是仓库管理员或组织所有者,您可以为组织拥有的私有仓库启用 秘密扫描。 You can enable 秘密扫描 for all your repositories, or for all new repositories within your organization. 秘密扫描 is not available for user-owned private repositories. For more information, see "Managing security and analysis settings for your repository" and "Managing security and analysis settings for your organization."

将提交推送到启用了 秘密扫描 的私有仓库时,GitHub 会扫描提交的内容中是否有密码。

当 秘密扫描 在私有仓库中检测到密码时,GitHub 会生成警报。

  • GitHub 向仓库管理员和组织所有者发送电子邮件警报。

  • GitHub 向提交机密到仓库的贡献者发送电子邮件警报,其中包括指向相关 秘密扫描 警报的链接。 然后,提交作者可以在仓库中查看警报,然后解决警报。

  • GitHub 显示仓库中的警报。

有关查看和解析 秘密扫描 警报的详细信息,请参阅“管理来自 秘密扫描 的警报”。

仓库管理员和组织所有者可以授权用户和团队访问 秘密扫描 警报。 更多信息请参阅“管理仓库的安全和分析设置”。

要监控来自私有仓库或组织中的 秘密扫描 的结果,可以使用 秘密扫描 API。 有关 API 端点的更多信息,请参阅“秘密扫描”。

GitHub 目前扫描私有仓库,以检查由以下服务提供者颁发的密码。

合作伙伴支持的密钥API slug
n/aJSON Web 令牌json_web_token
n/aOAuth 客户端凭据api_credential_assignment
Adafruit IOAdafruit IO 密钥adafruit_io_key
Alibaba CloudAlibaba 云访问密钥 IDalibaba_cloud_access_key_id
Alibaba CloudAlibaba 云访问密钥机密alibaba_cloud_access_key_secret
Amazon Web Services (AWS)Amazon AWS 访问密钥 IDaws_access_key_id
Amazon Web Services (AWS)Amazon AWS 机密访问密钥aws_secret_access_key
AsanaAsana 个人访问令牌asana_personal_access_token
AtlassianAtlassian API 令牌atlassian_api_token
AtlassianAtlassian JSON Web 令牌atlassian_jwt
AzureAzure DevOps 个人访问令牌azure_devops_personal_access_token
AzureAzure SAS 令牌azure_sas_token
AzureAzure 服务管理证书azure_management_certificate
AzureAzure SQL 连接字符串azure_sql_connection_string
AzureAzure 存储账户密钥azure_storage_account_key
ClojarsClojars 部署令牌clojars_deploy_token
CloudBees CodeShipCloudBees CodeShip 凭据codeship_credential
DatabricksDatabricks 访问令牌databricks_access_token
DiscordDiscord 自动程序令牌discord_bot_token
DopplerDoppler 个人令牌doppler_personal_token
DopplerDoppler 服务令牌doppler_service_token
DopplerDoppler CLI 令牌doppler_cli_token
DopplerDoppler SCIM 令牌doppler_scim_token
DropboxDropbox 访问令牌dropbox_access_token
DropboxDropbox 短暂访问令牌dropbox_short_lived_access_token
DynatraceDynatrace 访问令牌dynatrace_access_token
DynatraceDynatrace 内部令牌dynatrace_internal_token
FacebookFacebook Access Tokenfacebook_access_token
FinicityFinicity App 密钥finicity_app_key
Frame.ioFrame.io JSON Web 令牌frameio_jwt
Frame.ioFrame.io Developer 令牌frameio_developer_token
GitHubGitHub SSH 私钥github_ssh_private_key
GitHubGitHub 个人访问令牌github_personal_access_token
GitHubGitHub App 安装访问令牌github_app_installation_access_token
GoCardlessGoCardless 实时访问令牌gocardless_live_access_token
GoCardlessGoCardless Sandbox 访问令牌gocardless_sandbox_access_token
Google CloudGoogle API 密钥google_api_key
Google CloudGoogle Cloud 私钥 IDgoogle_cloud_private_key_id
GrafanaGrafana API 密钥grafana_api_key
Hashicorp TerraformTerraform Cloud / Enterprise API 令牌terraform_api_token
HubspotHubspot API 密钥hubspot_api_key
IntercomIntercom 访问令牌intercom_access_token
LobLob Live API 密钥lob_live_api_key
LobLob Test API 密钥lob_test_api_key
MailchimpMailchimp API 密钥mailchimp_api_key
MailgunMailgun API 密钥mailgun_api_key
npmnpm 访问令牌npm_access_token
NuGetNuGet API 密钥nuget_api_key
PalantirPalantir JSON Web 令牌palantir_jwt
PostmanPostman API 密钥postman_api_key
ProctorioProctorio 消费者密钥proctorio_consumer_key
ProctorioProctorio 链接密钥proctorio_linkage_key
ProctorioProctorio 注册密钥proctorio_registration_key
ProctorioProctorio 密钥proctorio_secret_key
PulumiPulumi 访问令牌pulumi_access_token
PyPIPyPI API 令牌pypi_api_token
RubyGemsRubyGems API 密钥rubygems_api_key
SamsaraSamsara API 令牌samsara_api_token
SamsaraSamsara OAuth 访问令牌samsara_oauth_access_token
SendGridSendGrid API Keysendgrid_api_key
ShopifyShopify App 共享密钥shopify_app_shared_secret
ShopifyShopify 访问令牌shopify_access_token
ShopifyShopify 自定义应用访问令牌shopify_custom_app_access_token
ShopifyShopify 私人应用密码shopify_private_app_password
SlackSlack API 令牌slack_api_token
SlackSlack 传入 web 挂钩 URLslack_incoming_webhook_url
SlackSlack 工作流程 web 挂钩 URLslack_workflow_webhook_url
SSLMateSSLMate API 密钥sslmate_api_key
SSLMateSSLMate 集群密钥sslmate_cluster_secret
StripeStripe API Keystripe_api_key
StripeStripe Live API 密钥stripe_live_secret_key
StripeStripe 测试 API 密钥stripe_test_secret_key
StripeStripe Live API 限制密钥stripe_live_restricted_key
StripeStripe 测试 API 限制密钥stripe_test_restricted_key
Tencent Cloud腾讯云密钥 IDtencent_cloud_secret_id
TwilioTwilio 帐户字符串标识符twilio_account_sid
TwilioTwilio API 密钥twilio_api_key

注: 秘密扫描 当前不允许定义自己的模式来检测密码。

延伸阅读

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。