BasisTheory.net 1.28.0

Basis Theory .NET SDK

The Basis Theory .NET SDK for .NET Core 2.1+, .NET Standard 2.1+, and .NET Framework 4.6.1+.

Installation

Using the .NET Core command-line interface (CLI) tools:

dotnet add package BasisTheory.net

Using the NuGet Command Line Interface (CLI):

nuget install BasisTheory.net

Using the Package Manager Console:

Install-Package BasisTheory.net

Documentation

For a complete list of endpoints and examples, please refer to our API docs

Usage

Per-request configuration

All of the service methods accept an optional RequestOptions object. This is used if you want to set a correlation ID or if you want to set a per-request BT-API-KEY

var requestOptions = new RequestOptions();
requestOptions.ApiKey = "API KEY";
requestOptions.CorrelationId = Guid.NewGuid().ToString();

Using a custom HttpClient

Each client can be configured to use a custom HttpClient:

var httpClient = new HttpClient();
var client = new TokenClient(apiKey, httpClient: httpClient);

Setting a custom API Url

Each client can set a custom API Url, such as calling a deployed instance of the Token Proxy.

var client = new TokenClient(apiKey, apiBaseUrl: "https://token-proxy.somedomain.com");

AspNetCore Setup

See complete documentation in the BasisTheory.net.AspNetCore project

Encryption and Key Management

Encryption and Key Management is provided to enable you to manage your own data encryption and key storage with your KMS provider of choice.

Key Management

var rsaProviderKeyFactory = new RSAKeyVaultProviderKeyFactory();

var providerKeyService = new ProviderKeyService(new CachingService(), 
  new List<IProviderKeyFactory> { 
    rsaProviderKeyFactory 
  });

// Retrieves or creates a key by name with a registered IProviderKeyFactory for the provided provider and algorithm
var providerEncryptionKey = providerKeyService.GetOrCreateKeyAsync("encryption-key", "AZURE", "RSA");

providerEncryptionKey = providerKeyService.GetKeyByKeyIdAsync(providerEncryptionKey.KeyId);

Encrypt and Decrypt

// Encryption Factory which has a provider and algorithm implementation for the ProviderEncryptionKey
var rsaEncryptionFactory = new RSAKeyVaultEncryptionFactory();
var encryptionService = new EncryptionService(new List<IEncryptionFactory> { 
  rsaEncryptionFactory 
});

// Provider Encryption Key which was generated from the ProviderKeyService
var providerEncryptionKey = new ProviderEncryptionKey {
  KeyId = Guid.NewGuid().ToString(),
  ProviderKeyId = "https://custom-kms.vault.azure.net/keys/encryption-key/809b10a3cedb83e83bbaeb5e8c762fab",
  Algorithm = "RSA",
  Provider = "AZURE"
};

// Encrypt string to get back a wrapped EncryptedData with a reference to the ProvderEncryptionKey
var encryptedData = encryptionService.Encrypt("My Super Secret", providerEncryptionKey);

// Use Encrypted Data and Provider Encryption Key to decrypt the the value and get back the original plaintext
var plaintext = encryptionService.Decrypt(encryptedData, providerEncryptionKey);

Development

The provided scripts with the SDK will check for all dependencies, start docker, build the solution, and run all tests.

Dependencies

• Docker
• Docker Compose
• .NET 5

Build the SDK and run Tests

Run the following command from the root of the project:

make verify