My Docusign Integration Key leaked! What should I do?
What is a Docusign Integration Key and how it is used?
An Integration Key in Docusign is a unique identifier that allows an application to securely authenticate and communicate with the Docusign API for managing and sending documents.
When integrating with Docusign, the Integration Key is primarily used for the following main purposes:
Authentication: The Integration Key is used to authenticate your application with Docusign's API, ensuring secure communication between the two systems.
Authorization: It is used to grant specific permissions and access levels to your application, allowing it to interact with Docusign's services based on the defined scope.
Auditing and Tracking: The Integration Key helps in tracking and auditing the activities performed by your application within the Docusign environment, providing a way to monitor and manage the usage of the integration.
---]
[---
1. Code snippets to prevent Docusign Integration Key hardcoding using environment variables
Using environment variables for storing sensitive information like Docusign Integration Key in your code is a secure practice because:
Environment variables are not hard-coded in the codebase, reducing the risk of exposure in case of code leaks or unauthorized access.
Environment variables are stored outside of the code repository, providing an additional layer of security.
Environment variables can be easily managed and updated without having to modify the code itself.
Environment variables are accessible only to the specific process or application that needs them, limiting the exposure of sensitive information.
2. Code snippet to prevent Docusign Integration Key hardcoding using AWS Secrets Manager
Using AWS Secrets Manager to manage Docusign Integration Keys is a secure way to handle sensitive data. Here are code snippets in five different programming languages that demonstrate how to retrieve the Docusign Integration Key from AWS Secrets Manager.
--
---]
[---
3. Code snippet to prevent Docusign Integration Key hardcoding using HashiCorp Vault
Using HashiCorp Vault for managing Docusign Integration Keys is a great way to enhance security. Here are code snippets in five different programming languages for securely handling a Docusign Integration Key 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 Docusign Integration Key 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 Docusign Integration Key hardcoding using CyberArk Conjur
Using CyberArk Conjur to manage Docusign Integration Key is a secure way to handle sensitive data. Here are code snippets in five different programming languages that demonstrate how to retrieve the Docusign Integration Key from CyberArk Conjur.
--
---]
[---
How to generate a Docusign Integration Key?
To generate a Docusign Integration Key, follow these steps:
Log in to your Docusign Developer Account.
Go to the Admin section of your account.
Click on the "Apps and Keys" tab.
Click on the "Add App & Integration Key" button.
Fill out the required information for your Integration Key, such as the name and description.
Choose the appropriate permissions for your Integration Key.
Click on the "Save" button to generate your Integration Key.
---]
[---
My Docusign Integration Key leaked, what are the possible reasons?
There are several reasons why a Docusign Integration Key might have been leaked:
Weak security practices: If the Integration Key was not properly secured, such as being stored in a publicly accessible repository or shared insecurely, it could have been easily leaked.
Insufficient access controls: If the Integration Key was shared with individuals who did not have a need-to-know or access to it, there is a higher risk of it being leaked.
Human error: Mistakes such as accidentally exposing the Integration Key in code snippets, configuration files, or documentation can lead to its leakage.
Malicious intent: In some cases, an individual may intentionally leak the Integration Key for personal gain or to harm the organization.
What are the risks of leaking a Docusign Integration Key
When it comes to the Docusign Integration Key, it is crucial for developers to understand the risks associated with leaking this key. Here are some specific risks:
Unauthorized Access: If the Integration Key is leaked, unauthorized individuals may gain access to sensitive documents and information stored on Docusign.
Data Breach: Leaking the Integration Key can lead to a data breach, compromising the confidentiality of important documents and potentially exposing personal or sensitive information.
Financial Loss: A security breach resulting from a leaked Integration Key can lead to financial loss for the organization, including potential legal fees, fines, and damage to the company's reputation.
Compromised Trust: If customer data is exposed due to a leaked Integration Key, it can erode trust and credibility with clients, leading to a loss of business and reputation damage.
---]
[---
Docusign Integration Key security best practices
Avoid embedding the secret directly in your code. Instead, use environment variables or secrets managers
Secure storage: store the Docusign Integration Key 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 Docusign Integration Key usage and improve the overall security of your Docusign Integration Key implementations.
How to check if Docusign Integration Key was used by malicious actors
Review Access Logs: Check the access logs of your Docusign Integration Key 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 Docusign Integration Key. This can give insights into any unauthorized use of your key.
---]
[---
Steps to revoke the Docusign Integration Key
Generate a new Docusign Integration Key:
Log into your Docusign Integration Key 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 Docusign Integration Key:
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 Docusign Integration Key.
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.
---]
Environment Variables
Environment Variables
Environment Variables
charge
nullable string
For card errors, the ID of the failed charge.
payment_method_type
nullable string
If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
doc_url
nullable string
A URL to more information about the error code reported.
request_log_url
nullable string
A URL to the request log entry in your dashboard.
charge
nullable string
If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
For some errors that could be handled programmatically, a short string indicating the error code reported.
charge
nullable string
If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.