[---

My CircleCI Project API Token leaked! What should I do?

What is a CircleCI Project API Token and how it is used?

A CircleCI Project API Token is a unique authentication token that allows access to the CircleCI API for a specific project. It is used to authorize API requests and perform actions such as triggering builds or retrieving information about the project.

Here are the main use cases for the CircleCI Project API Token:

Authenticating API requests: The CircleCI Project API Token is used to authenticate API requests made to the CircleCI platform. This token ensures that only authorized users and applications can access and interact with the CircleCI API.
Triggering builds and workflows: Developers can use the Project API Token to trigger builds and workflows in CircleCI. By including the token in API requests, developers can automate the process of starting builds and running workflows without manual intervention.
Accessing project-specific information: The Project API Token allows developers to retrieve project-specific information from the CircleCI platform. This can include details about builds, workflows, and other project-related data that can be useful for monitoring and analyzing the project's CI/CD pipeline.

---]

[---

1. Code snippets to prevent CircleCI Project API Token hardcoding using environment variables

Using environment variables for storing sensitive information like CircleCI Project API Token is a secure practice because:

Environment variables are not hard-coded in the codebase, reducing the risk of accidental exposure through version control systems or code reviews.
Environment variables are stored outside the codebase and are not visible in the source code, making it harder for attackers to access them.
Environment variables can be managed and controlled by the CI/CD platform, allowing for easy rotation and revocation of tokens without changing the code.

How to secure your secrets using environment variables

---]

[---

2. Code snippet to prevent CircleCI Project API Token hardcoding using AWS Secrets Manager

Using AWS Secrets Manager to manage CircleCI Project API Tokens is a secure way to handle sensitive data. Here are code snippets in five different programming languages that demonstrate how to retrieve the CircleCI Project API Token from AWS Secrets Manager.

---]

[---

3. Code snippet to prevent CircleCI Project API Token hardcoding using HashiCorp Vault

Using HashiCorp Vault for managing CircleCI Project API Tokens is a great way to enhance security. Here are code snippets in five different programming languages for securely handling a CircleCI Project API Token using HashiCorp Vault.

Remember to replace the VAULT_ADDR and VAULT_TOKEN with your Vault server address and authentication token. The snippets assume that the CircleCI Project API Token is stored under the api_key field within Vault. The specifics of the Vault path and field names should be adjusted to match your Vault setup.

---]

[---

4. Code snippet to prevent CircleCI Project API Token hardcoding using CyberArk Conjur

Using CyberArk Conjur to manage CircleCI Project API Token is a secure way to handle sensitive data. Here are code snippets in five different programming languages that demonstrate how to retrieve the CircleCI Project API Token from CyberArk Conjur.

---]

[---

How to generate a CircleCI Project API Token?

To generate a CircleCI Project API Token, follow these steps:

Log in to your CircleCI account.
Go to the project settings for the specific project you want to generate the token for.
Click on the "API Permissions" tab.
Under the "Personal API Tokens" section, click on the "Create Token" button.
Enter a description for the token to easily identify its purpose.
Click on the "Create Token" button to generate the API token.

Make sure to securely store the generated API token as it will be needed for authenticating API requests to the CircleCI project.

---]

[---

My CircleCI Project API Token leaked, what are the possible reasons?

There are several reasons why a CircleCI Project API Token might have been leaked:

Improper storage: Storing the API token in a public repository or in an insecure location can lead to its exposure.
Accidental sharing: Developers may inadvertently share the API token in communication channels or code snippets.
Weak access controls: Insufficient access controls or sharing of credentials among team members can result in unauthorized access to the token.
Compromised systems: If the systems where the API token is stored are compromised, attackers can gain access to the token.

What are the risks of leaking a CircleCI Project API Token

Leaking a CircleCI Project API Token can pose serious risks to the security of your project and organization. It is important for developers to understand the implications of such a breach in order to prevent it from happening.

Unauthorized Access: If a malicious actor gains access to your CircleCI Project API Token, they can potentially view and manipulate sensitive information within your project, such as source code, environment variables, and deployment configurations.
Data Breach: The exposure of a CircleCI Project API Token can lead to a data breach, compromising the confidentiality and integrity of your project's data. This can have severe consequences for your organization, including financial losses and damage to your reputation.
Unauthorized Builds: An attacker with access to your CircleCI Project API Token can trigger unauthorized builds, potentially introducing malicious code into your project or disrupting your development workflow.
Resource Abuse: By exploiting a leaked CircleCI Project API Token, malicious actors can abuse your project's resources, leading to increased costs, performance issues, and potential service disruptions.

It is crucial for developers to follow best practices for secret management and detection to prevent the leakage of sensitive information like CircleCI Project API Tokens. By raising awareness about the risks associated with such breaches, we can collectively work towards enhancing the security posture of our projects and organizations.

---]

[---

CircleCI Project API Token security best practices

Avoid embedding the secret directly in your code. Instead, use environment variables or secrets managers‍
Secure storage: store the CircleCI Project API Token in a secure location, such as a password manager or a secrets management service.
Regular rotation: periodically rotate the API key to minimize the risk of long-term exposure.
Restrict permissions: apply the principle of least privilege by only granting the key the minimum necessary permissions.
Monitor usage: regularly check the usage logs for any unusual activity or unauthorized access attempts.
Implement access controls: limit the number of users who have access to the secret and enforce strong authentication measures.
Use a secrets manager: utilize secret management tools like CyberArk or AWS Secrets Manager for enhanced security.

By adhering to the best practices, you can significantly reduce the risk associated with CircleCI Project API Token usage and improve the overall security of your CircleCI Project API Token implementations.

Exposing secrets on GitHub: What to do after leaking Credential and API keys

---]

[---

CircleCI Project API Token leak remediation: what to do

What to do if you expose a secret: How to stay calm and respond to an incident [cheat sheet included]

How to check if CircleCI Project API Token was used by malicious actors

Review Access Logs: Check the access logs of your CircleCI Project API Token account for any unauthorized access or unusual activity. Pay particular attention to access from unfamiliar IP addresses (if you haven’t set up a specific allow list) or at odd hours.
Monitor Usage Patterns: Look for anomalies in the usage patterns, such as unexpected spikes in data access or transfer.
Check Active Connections and Operations: Review the list of active connections and recent operations on your database. Unusual or unauthorized operations might indicate malicious use.
Audit API Usage: If possible, audit the usage of your API key through any logging or monitoring services you have integrated with CircleCI Project API Token. This can give insights into any unauthorized use of your key.

---]

[---

Steps to revoke the CircleCI Project API Token

Generate a new CircleCI Project API Token:

Log into your CircleCI Project API Token account.
Navigate to the API section and generate a new API key.

Update Services with the new key:

Replace the compromised key with the new key in all your services that use this API key.
Ensure all your applications and services are updated with the new key before deactivating the old one.

Deactivate the old CircleCI Project API Token:

Once the new key is in place and everything is functioning correctly, deactivate the old API key.
This can typically be done from the same section where you generated the new key.

Monitor after key rotation:

After deactivating the old key, monitor your systems closely to ensure that all services are running smoothly and that there are no unauthorized access attempts.

---]

[---

How to understand which services will stop working

Inventory of services: keep an inventory of all services and applications that utilize your CircleCI Project API Token.
Communication and documentation: Ensure that your team is aware of which services are dependent on the key. Maintain documentation for quick reference.
Testing: before deactivating the old key, test your services with the new key in a staging environment. This helps in identifying any services that might face issues post rotation.
Fallback strategies: Have a fallback or emergency plan in case a critical service fails after the key rotation. This might include temporary measures or quick rollback procedures.

In summary, the remediation process involves identifying potential misuse, carefully rotating the key, and ensuring minimal disruption to services. Being proactive and having a well-documented process can greatly reduce the risks associated with a compromised API key.

---]

[---

What about other secrets?

GitGuardian helps developers keep 350+ types of secrets out of source code. GitGuardian’s automated secrets detection and remediation solution secure every step of the development lifecycle, from code to cloud:

On developer workstations with git hooks (pre-commit and pre-push);
On code sharing platforms like GitHub, GitLab, and Bitbucket;
In CI environments (Circle CI, Travis CI, Jenkins CI, GitHub Actions, and many more);
In Docker images.

---]

payment_intent

nullable object

The PaymentIntent object for errors returned on a request involving a PaymentIntent.

Hide

Show

child attributes

CLIENT LIBRARIES

$ gem install stripe

STRIPE-RUBY

$ pip install stripe

STRIPE-PYTHON

$ composer require stripe/stripe-php

STRIPE-PHP

MAVEN
<dependency>
  <groupId>com.stripe</groupId>
  <artifactId>stripe-java</artifactId>
  <version>24.16.0</version>
</dependency>

GRADLE
compile "com.stripe:stripe-java:24.16.0"

STRIPE-NODE

$ npm install --save stripe

STRIPE-NODE

$ go get github.com/stripe/stripe-go/v76

STRIPE-NODE

$ nuget install Stripe.net

STRIPE-NODE

SHOW

This is placeholder code

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents

Table of Contents