Skip to content

Latest commit

 

History

History
237 lines (195 loc) · 10.4 KB

README.md

File metadata and controls

237 lines (195 loc) · 10.4 KB
Raw

LowkeyVault

GitHub license Java version latest-release Maven Central Docker Hub JavaCI

CII Best Practices code-climate-maintainability code-climate-tech-debt last_commit badge-abort-mission-armed-green

Lowkey Vault is a test double (fake object) aspiring to be compatible with Azure Key Vault REST APIs. The project aims to provide a low footprint alternative for the cases when using a real Key Vault is not practical or impossible.

Recommended use

Warning

Lowkey Vault is NOT intended as an Azure Key Vault replacement. Please do not attempt using it instead of the real service in production as it is not using any security measures to keep your secrets safe.

Valid use-cases

I have an app using Azure Key Vault and:

  • I want to be able to run my tests locally without internet connection; or
  • I do not want to keep a Key Vault alive for my CI instances; or
  • I do not want to figure out how to provide a new Key Vault every time my test run; or
  • I do not want to worry about authentication when using Key Vault locally.

Quick start guide

Java

  1. Either download manually the Spring Boot app from the packages or use Maven Central.
  2. Start Lowkey Vault jar
  3. Use https://localhost:8443 as key vault URI when using the Azure Key Vault Key client or the Azure Key Vault Secret client and set any basic credentials (Lowkey Vault will check whether they are there but ignore the value.)
  4. If you are using more than one vaults parallel
    1. Either set up all of their host names in hosts to point to localhost
    2. Or, use the provider in lowkey-vault-client to handle the mapping for you
    3. (Or mimic the same using your HTTP client provider)
  5. Initialize your keys or secrets using the client
  6. Run your code
  7. Stop Lowkey Vault

Docker

Note

A complex example is available here

  1. Pull the most recent version from nagyesta/lowkey-vault
    • You can find a list of all the available tags here
  2. docker run --rm -p 8443:8443 nagyesta/lowkey-vault:<version>
  3. Use https://localhost:8443 as key vault URI when using the Azure Key Vault Key client or the Azure Key Vault Secret client and set any basic credentials (Lowkey Vault will check whether they are there but ignore the value.)
  4. If you are using more than one vaults parallel
    1. Either set up all of their host names in hosts to point to localhost
    2. Or, use the provider in lowkey-vault-client to handle the mapping for you
    3. (Or mimic the same using your HTTP client provider)
  5. Initialize your keys or secrets using the client
  6. Run your code
  7. Stop Lowkey Vault

Testcontainers

See examples under Lowkey Vault Testcontainers.

Features

Lowkey Vault is far from supporting all Azure Key Vault features. The list supported functionality can be found here:

Keys

  • API version supported: 7.2, partially 7.3, 7.4, 7.5
  • Create key (RSA, EC, OCT)
    • Including metadata
  • Import key (RSA, EC, OCT)
    • Including metadata
  • Get available key versions
  • Get key
    • Latest version of a single key
    • Specific version of a single key
    • List of all keys
  • Get deleted key
    • Latest version of a single key
    • List of all keys
  • Delete key
  • Update key
  • Recover deleted key
  • Purge deleted key
  • Encrypt/Decrypt/Wrap/Unwrap keys
    • RSA (2k/3k/4k)
      • RSA1_5
      • RSA-OAEP
      • RSA-OAEP-256
    • AES (128/192/256)
      • AES-CBC
      • AES-CBC Pad
  • Sign/Verify digest with keys
    • RSA (2k/3k/4k)
      • PS256
      • PS384
      • PS512
      • RS256
      • RS384
      • RS512
    • EC (P-256/P-256K/P-384/P-521)
      • ES256
      • ES256K
      • ES384
      • ES512
  • Backup and restore keys
  • Get random bytes
  • Rotate keys
    • Manually
    • Automatically when time-shift is used with an applicable rotation policy
  • Get rotation policy
  • Update rotation policy

Secrets

  • API version supported: 7.2, 7.3, 7.4, 7.5
  • Set secret
    • Including metadata
  • Get available secret versions
  • Get secret
    • Latest version of a single secret
    • Specific version of a single secret
    • List of all secrets
  • Get deleted secret
    • Latest version of a single secret
    • List of all secrets
  • Delete secret
  • Update secret
  • Recover deleted secret
  • Purge deleted secret
  • Backup and restore secrets

Certificates

  • API version supported: 7.3, 7.4, 7.5
  • Create certificate
    • Self-signed only
    • Using PKCS12 (.pfx) or PEM (.pem) formats
    • The downloadable certificate is protected using a blank ("") password for PKCS12 stores
  • Get certificate operation
    • Get pending create operation results
    • Get pending delete operation results
  • Get available certificate versions
  • Get certificate
    • Latest version of a single certificate
    • Specific version of a single certificate
    • List of all certificates
  • Get certificate policy
  • Import certificate
    • Self-signed only
    • Using PKCS12 (.pfx) or PEM (.pem) formats
    • The downloadable certificate is protected using a blank ("") password for PKCS12 stores
  • Get deleted certificate
    • Latest version of a single certificate
    • List of all certificates
  • Delete certificate
  • Update certificate properties
  • Update certificate issuance policy
  • Recover deleted certificate
  • Purge deleted certificate
  • Backup and restore certificates

Management API

Functionality

  • Create vault
  • List vaults
  • Delete vault
  • List deleted vaults
  • Recover deleted vault
  • Purge vault
  • Time-shift (simulate the passing of time)
    • A single vault
    • All vaults
  • Export vault contents (to be able to import it at startup later)

Swagger

https://localhost:8443/api/swagger-ui/index.html

Port mappings (Default)

HTTP :8080

Used for metadata endpoints

  • Simulating Managed Identity Token endpoint GET /metadata/identity/oauth2/token?resource=<resource>.
  • Obtaining the default certificates of Lowkey Vault
    • The default PKCS12 keystore: GET /metadata/default-cert/lowkey-vault.p12
    • The password protecting the default keystore: GET /metadata/default-cert/password

Tip

Managed Identity Token endpoint provides the same Managed Identity stub as Assumed Identity. If you want to use Lowkey Vault with Managed Identity, this functionality allows you to do so with a single container.

HTTPS :8443

  • Readiness/Liveness /ping
  • Management API
  • Key Vault APIs

Startup parameters

  1. Using the .jar: Lowkey Vault App.
  2. Using Docker: Lowkey Vault Docker.
  3. Using Testcontainers: Lowkey Vault Testcontainers.

Example projects

  1. Java
  2. .Net
  3. Python
  4. Go
  5. Node.js
  6. Docker

Limitations

  • Some encryption/signature algorithms are not supported. Please refer to the "Features" section for the up-to-date list of supported algorithms.
  • Only self-signed certificates are supported by the certificate API.
  • Time shift cannot renew/recreate deleted certificates. Please consider performing deletions after time shift as a work around.
  • Recovery options cannot be configured for vaults created during start-up