Skip to content

Latest commit

 

History

History
161 lines (107 loc) · 5.71 KB

README.md

File metadata and controls

161 lines (107 loc) · 5.71 KB
Raw

ForemanVault

Foreman Vault is a plugin for Foreman that integrates with Hashicorp Vault for different things. Currently, it offers two distinct features.

1. Vault secrets in Foreman templates

This adds two new macros which can be used in Foreman templates:

  • vault_secret - Retreive secrets at a given Vault path
  • vault_issue_certificate - Issues new certificates

2. Management of Vault Policies and AuthMethods

Vault policies and auth methods (of type cert) can be created automatically as part of the host orchestration. Auth methods also get deleted after the host is removed from Foreman.

This allows Foreman to create everything needed to access Hashicorp Vault directly from a VM using it's Puppet certificate (e.g. for Deferred functions in Puppet or other CLI tools).

Compatibility

Foreman Version Plugin Version
>= 3.9 ~> 2.0
>= 2.3 ~> 1.0
>= 1.23 ~> 0.3, ~> 0.4
>= 1.20 ~> 0.2

Requirements

  • Foreman >= 1.20
  • Working Vault instance
    • with cert auth enabled
    • with approle auth enabled
    • with kv v1 secret store enabled
  • valid Vault Token

Dev Vault Instance

To run a local Vault dev environment on MacOS use:

$ brew install vault
$ vault server -dev
$ export VAULT_ADDR='http://127.0.0.1:8200'
$ vault secrets enable -version=1 kv
$ vault auth enable cert

$ vault token create -period=60m
[...]

To interact with Vault you can use Vault UI, which is available at http://127.0.0.1:8200/ui.

  • The AppRole auth method
$ vault auth enable approle
$ vault write auth/approle/role/my-role policies="default"
Success! Data written to: auth/approle/role/my-role
$ vault read auth/approle/role/my-role/role-id
Key        Value
---        -----
role_id    8403910c-e563-d2f2-1c77-6e26319be8b5
$ vault write -f auth/approle/role/my-role/secret-id
Key                   Value
---                   -----
secret_id             1058434b-b4aa-bf5a-b376-a15d9efb1059
secret_id_accessor    9cc19ed7-201f-7438-782e-561edd12b2a8

See also Vault CLI testing AppRole

Installation

See Plugins install instructions for how to install Foreman plugins.

Basic configuration

To create a new Vault connection navigate to Infrastructure -> Vault Connections and hit the Create Vault Connection button. There you can enter a name, the Vault URL and a secret token.

Vault secrets in templates

At this point you can utilize two new macros in your templates:

  • vault_secret(vault_connection_name, secret_path)
  • vault_issue_certificate(vault_connection_name, pki_role_path, options...)

vault_secret(vault_connection_name, secret_path)

To fetch secrets from Vault (you can write secrets with the vault write kv/my_secret foo=bar command), e.g.

<%= vault_secret('MyVault', 'kv/my_secret') %>

As result you should get secret data, e.g.

{:foo=>"bar"}

vault_issue_certificate(vault_connection_name, pki_role_path, options...)

Issueing certificates is just as easy. Be sure to have a correctly set-up PKI, meaning, configure it so you can generate certificates from within the Vault UI. This means that you'll have to set-up a CA or Intermediate CA. Once done, you can generate a certificate like this:

<%= vault_issue_certificate('MyVault', 'pkiEngine/issue/testRole', common_name: 'test.mydomain.com', ttl: '10s') %>

The common_name and ttl are optional, but there are more options to configure

Vault policies and auth methods

Policies

The policy is based on a new template kind VaultPolicy which is basically a Vault Policy extended with ERB.

The name of the policy is extracted from a Magic comment within the template. Therefore you can use ERB to influence the name:

# NAME: <%= @host.owner %>-<%= @host.environment %>

path "secret/foo" {
  capabilities = ["read"]
}

You can create multiple VaultPolicy templates and configure the default policy used in host orchestration by setting the Foreman Setting vault_policy_template to the desired one.

Note: If the policy renders empty (yes, you can use conditions within ERB), the orchestration is skipped!

Auth methods

Auth methods of type cert are created with three attributes:

  • certificate: content of the Foreman setting ssl_ca_file
  • allowed_common_names: FQDN of the host which triggered the orchestration
  • token_policies: This is automatically linked to the policy from above

Contributing

Fork and send a Pull Request. Thanks!

Copyright

Copyright (c) 2018-2020 dmTECH GmbH, dmtech.de

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.