Type '/' to Search

»Developer Quick Start

This quick start will explore how to use Vault client libraries inside your application code to store and retrieve your first secret value. Vault takes the security burden away from developers by providing a secure, centralized secret store for an application’s sensitive data: credentials, certificates, encryption keys, and more.

For an out-of-the-box runnable demo application showcasing these concepts and more, see the hello-vault repositories (Go, C# and Java/Spring Boot).

»Prerequisites

  • Docker or a local installation of the Vault binary
  • A development environment applicable to one of the languages in this quick start (currently Go, Ruby, C#, Python, and Java (Spring))

»Step 1: Start Vault

Warning: This in-memory “dev” server is useful for practicing with Vault locally for the first time, but is insecure and should never be used in production. For developers who need to manage their own production Vault installations, this page provides some guidance on how to make your setup more production-friendly.

Run the Vault server in a non-production "dev" mode in one of the following ways:

For Docker users, run this command:

$ docker run -p 8200:8200 -e 'VAULT_DEV_ROOT_TOKEN_ID=dev-only-token' vault

$ docker run -p 8200:8200 -e 'VAULT_DEV_ROOT_TOKEN_ID=dev-only-token' vault

For non-Docker users, run this command:

$ vault server -dev -dev-root-token-id="dev-only-token"

$ vault server -dev -dev-root-token-id="dev-only-token"

The -dev-root-token-id flag for dev servers tells the Vault server to allow full root access to anyone who presents a token with the specified value (in this case "dev-only-token").

Warning: The root token is useful for development, but allows full access to all data and functionality of Vault, so it must be carefully guarded in production. Ideally, even an administrator of Vault would use their own token with limited privileges instead of the root token.

Vault is now listening over HTTP on port 8200. With all the setup out of the way, it's time to get coding!

»Step 2: Install a client library

To read and write secrets in your application, you need to first configure a client to connect to Vault. Let's install the Vault client library for your language of choice.

Note: Some of these libraries are currently community-maintained.

Go (official) client library:

$ go get github.com/hashicorp/vault/api

$ go get github.com/hashicorp/vault/api

Now, let's add the import statements for the client library to the top of the file.

import vault "github.com/hashicorp/vault/api"
import statements for client library
1import vault "github.com/hashicorp/vault/api"

»Step 3: Authenticate to Vault

A variety of authentication methods can be used to prove your application's identity to the Vault server. To explore more secure authentication methods, such as via Kubernetes or your cloud provider, see the auth code snippets in the vault-examples repository.

To keep things simple for our example, we'll just use the root token created in Step 1. Paste the following code to initialize a new Vault client that will use token-based authentication for all its requests:

initialize a new vault client
Go
config := vault.DefaultConfig()

config.Address = "http://127.0.0.1:8200"

client, err := vault.NewClient(config)
if err != nil {
    log.Fatalf("unable to initialize Vault client: %v", err)
}

client.SetToken("dev-only-token")

1 2 3 4 5 6 7 8 9 10config := vault.DefaultConfig()

config.Address = "http://127.0.0.1:8200"

client, err := vault.NewClient(config)
if err != nil {
    log.Fatalf("unable to initialize Vault client: %v", err)
}

client.SetToken("dev-only-token")

Vault.configure do |config|
    config.address = "http://127.0.0.1:8200"
    config.token = "dev-only-token"
end

1234Vault.configure do |config|
    config.address = "http://127.0.0.1:8200"
    config.token = "dev-only-token"
end

IAuthMethodInfo authMethod = new TokenAuthMethodInfo(vaultToken: "dev-only-token");

VaultClientSettings vaultClientSettings = new
VaultClientSettings("http://127.0.0.1:8200", authMethod);
IVaultClient vaultClient = new VaultClient(vaultClientSettings);

12345IAuthMethodInfo authMethod = new TokenAuthMethodInfo(vaultToken: "dev-only-token");

VaultClientSettings vaultClientSettings = new
VaultClientSettings("http://127.0.0.1:8200", authMethod);
IVaultClient vaultClient = new VaultClient(vaultClientSettings);

client = hvac.Client(
    url='http://127.0.0.1:8200',
    token='dev-only-token',
)

1234client = hvac.Client(
    url='http://127.0.0.1:8200',
    token='dev-only-token',
)

VaultEndpoint vaultEndpoint = new VaultEndpoint();

vaultEndpoint.setHost("127.0.0.1");
vaultEndpoint.setPort(8200);
vaultEndpoint.setScheme("http");

VaultTemplate vaultTemplate = new VaultTemplate(
    vaultEndpoint,
    new TokenAuthentication("dev-only-token")
);

1 2 3 4 5 6 7 8 9 10VaultEndpoint vaultEndpoint = new VaultEndpoint();

vaultEndpoint.setHost("127.0.0.1");
vaultEndpoint.setPort(8200);
vaultEndpoint.setScheme("http");

VaultTemplate vaultTemplate = new VaultTemplate(
    vaultEndpoint,
    new TokenAuthentication("dev-only-token")
);

»Step 4: Store a secret

Secrets are sensitive data like API keys and passwords that we shouldn’t be storing in our code or configuration files. Instead, we want to store values like this in Vault.

We'll use the Vault client we just initialized to write a secret to Vault, like so:

write a secret to vault
Go
secretData := map[string]interface{}{
    "data": map[string]interface{}{
        "password": "Hashi123",
    },
}


_, err = client.Logical().Write("secret/data/my-secret-password", secretData)
if err != nil {
    log.Fatalf("unable to write secret: %v", err)
}

fmt.Println("Secret written successfully.")

1 2 3 4 5 6 7 8 9 10111213secretData := map[string]interface{}{
    "data": map[string]interface{}{
        "password": "Hashi123",
    },
}


_, err = client.Logical().Write("secret/data/my-secret-password", secretData)
if err != nil {
    log.Fatalf("unable to write secret: %v", err)
}

fmt.Println("Secret written successfully.")

secret_data = {data: {password: "Hashi123"}}
Vault.logical.write("secret/data/my-secret-password", secret_data)

puts "Secret written successfully."

1234secret_data = {data: {password: "Hashi123"}}
Vault.logical.write("secret/data/my-secret-password", secret_data)

puts "Secret written successfully."

var secretData = new Dictionary<string, object> { { "password", "Hashi123" } };
vaultClient.V1.Secrets.KeyValue.V2.WriteSecretAsync(
    path: "/my-secret-password",
    data: secretData,
    mountPoint: "secret"
).Wait();

Console.WriteLine("Secret written successfully.");

12345678var secretData = new Dictionary<string, object> { { "password", "Hashi123" } };
vaultClient.V1.Secrets.KeyValue.V2.WriteSecretAsync(
    path: "/my-secret-password",
    data: secretData,
    mountPoint: "secret"
).Wait();

Console.WriteLine("Secret written successfully.");

create_response = client.secrets.kv.v2.create_or_update_secret(
    path='my-secret-password',
    secret=dict(password='Hashi123'),
)

print('Secret written successfully.')

123456create_response = client.secrets.kv.v2.create_or_update_secret(
    path='my-secret-password',
    secret=dict(password='Hashi123'),
)

print('Secret written successfully.')

Map<String, String> data = new HashMap<>();
data.put("password", "Hashi123");

Versioned.Metadata createResponse = vaultTemplate
    .opsForVersionedKeyValue("secret")
    .put("my-secret-password", data);

System.out.println("Secret written successfully.");

12345678Map<String, String> data = new HashMap<>();
data.put("password", "Hashi123");

Versioned.Metadata createResponse = vaultTemplate
    .opsForVersionedKeyValue("secret")
    .put("my-secret-password", data);

System.out.println("Secret written successfully.");

A common way of storing secrets is as key-value pairs using the KV secrets engine (v2). In the code we've just added, password is the key in the key-value pair, and Hashi123 is the value.

We also provided the path to our secret in Vault. We will reference this path in a moment when we learn how to retrieve our secret.

Run the code now, and you should see Secret written successfully. If not, check that you've used the correct value for the root token and Vault server address.

»Step 5: Retrieve a secret

Now that we know how to write a secret, let's practice reading one.

Underneath the line where you wrote a secret to Vault, let's add a few more lines, where we will be retrieving the secret and unpacking the value:

read a secret
Go
secret, err := client.Logical().Read("secret/data/my-secret-password")
if err != nil {
    log.Fatalf("unable to read secret: %v", err)
}

data, ok := secret.Data["data"].(map[string]interface{})
if !ok {
    log.Fatalf("data type assertion failed: %T %#v", secret.Data["data"], secret.Data["data"])
}

key := "password"
value, ok := data[key].(string)
if !ok {
    log.Fatalf("value type assertion failed: %T %#v", data[key], data[key])
}

1 2 3 4 5 6 7 8 9 101112131415secret, err := client.Logical().Read("secret/data/my-secret-password")
if err != nil {
    log.Fatalf("unable to read secret: %v", err)
}

data, ok := secret.Data["data"].(map[string]interface{})
if !ok {
    log.Fatalf("data type assertion failed: %T %#v", secret.Data["data"], secret.Data["data"])
}

key := "password"
value, ok := data[key].(string)
if !ok {
    log.Fatalf("value type assertion failed: %T %#v", data[key], data[key])
}

secret = Vault.logical.read("secret/data/my-secret-password")
password = secret.data[:data][:password]

12secret = Vault.logical.read("secret/data/my-secret-password")
password = secret.data[:data][:password]

Secret<SecretData> secret = vaultClient.V1.Secrets.KeyValue.V2.ReadSecretAsync(
    path: "/my-secret-password",
    mountPoint: "secret"
).Result;

var password = secret.Data.Data["password"];

123456Secret<SecretData> secret = vaultClient.V1.Secrets.KeyValue.V2.ReadSecretAsync(
    path: "/my-secret-password",
    mountPoint: "secret"
).Result;

var password = secret.Data.Data["password"];

read_response = client.secrets.kv.read_secret_version(path='my-secret-password')

password = read_response['data']['data']['password']

123read_response = client.secrets.kv.read_secret_version(path='my-secret-password')

password = read_response['data']['data']['password']

Versioned<Map<String, Object>> readResponse = vaultTemplate
    .opsForVersionedKeyValue("secret")
    .get("my-secret-password");

String password = "";
if (readResponse != null && readResponse.hasData()) {
    password = (String) readResponse.getData().get("password");
}

12345678Versioned<Map<String, Object>> readResponse = vaultTemplate
    .opsForVersionedKeyValue("secret")
    .get("my-secret-password");

String password = "";
if (readResponse != null && readResponse.hasData()) {
    password = (String) readResponse.getData().get("password");
}

Last, confirm that the value we unpacked from the read response is correct:

confirm value
Go
if value != "Hashi123" {
    log.Fatalf("unexpected password value %q retrieved from vault", value)
}

fmt.Println("Access granted!")

12345if value != "Hashi123" {
    log.Fatalf("unexpected password value %q retrieved from vault", value)
}

fmt.Println("Access granted!")

abort "Unexpected password" if password != "Hashi123"

puts "Access granted!"

123abort "Unexpected password" if password != "Hashi123"

puts "Access granted!"

if (password.ToString() != "Hashi123")
{
    throw new System.Exception("Unexpected password");
}

Console.WriteLine("Access granted!");

123456if (password.ToString() != "Hashi123")
{
    throw new System.Exception("Unexpected password");
}

Console.WriteLine("Access granted!");

if password != 'Hashi123':
    sys.exit('unexpected password')

print('Access granted!')

1234if password != 'Hashi123':
    sys.exit('unexpected password')

print('Access granted!')

if (!password.equals("Hashi123")) {
    throw new Exception("Unexpected password");
}

System.out.println("Access granted!");

12345if (!password.equals("Hashi123")) {
    throw new Exception("Unexpected password");
}

System.out.println("Access granted!");

If the secret was fetched successfully, you should see the Access granted! message after you run the code. If not, check to see if you provided the correct path to your secret.

That's it! You've just written and retrieved your first Vault secret!

The complete code samples for the steps you've just performed in this quick start are available here:

»Additional examples

For more secure examples of client authentication, see the auth snippets in the vault-examples repo.

For a runnable demo app that demonstrates more features, for example, how to keep your connection to Vault alive and how to connect to a database using Vault's dynamic database credentials, see the sample application hello-vault (Go, C#).

To learn how to integrate applications with Vault without needing to always change your application code, see the Vault Agent documentation.