Basic Usage
TEST
from the dev
environment of the PROJECT_ID
project.
We do not recommend hardcoding your Machine Identity Tokens. Setting it as an environment variable would be best.
Installation
Runnpm
to add @infisical/sdk
to your project.
Configuration
Import the SDK and create a client instance with your Machine Identity.ClientSettings methods
Caching
To reduce the number of API requests, the SDK temporarily stores secrets it retrieves. By default, a secret remains cached for 5 minutes after it’s first fetched. Each time it’s fetched again, this 5-minute timer resets. You can adjust this caching duration by setting the “cacheTTL” option when creating the client.Working with Secrets
client.ListSecrets(options)
Parameters
client.GetSecret(options)
GetSecret()
fetches and returns a shared secret.
Parameters
client.CreateSecret(options)
Parameters
client.UpdateSecret(options)
Parameters
client.DeleteSecret(options)
Parameters
Cryptography
Create a symmetric key
Create a base64-encoded, 256-bit symmetric key to be used for encryption/decryption.Returns (string)
key
(string): A base64-encoded, 256-bit symmetric key, that can be used for encryption/decryption purposes.
Encrypt symmetric
Parameters
Returns (object)
Tag
(string): A base64-encoded, 128-bit authentication tag.
Iv
(string): A base64-encoded, 96-bit initialization vector.
CipherText
(string): A base64-encoded, encrypted ciphertext.
Decrypt symmetric
Parameters
Returns (string)
Plaintext
(string): The decrypted plaintext.