ricsanfre.vault

Przegląd Wersje Wgląd

Ansible Rola: Instalacja i Konfiguracja Serwera Hashicorp Vault

Ta rola instaluje i konfiguruje Hashicorp Vault na serwerze linuxowym.

Wymagania

Brak

Zmienne Roli

Dostępne zmienne są wymienione poniżej wraz z wartościami domyślnymi (patrz defaults\main.yaml)

Szczegóły instalacji serwera Vault

Użytkownik/grupa UNIX dla Vault

vault_group: vault
vault_user: vault

Pakiet Vault i wersja do zainstalowania

vault_version: 1.12.2

Ścieżki instalacji Vault

vault_bin_path: /usr/local/bin
vault_config_path: /etc/vault
vault_tls_path: /etc/vault/tls
vault_plugin_path: /usr/local/lib/vault/plugins
vault_data_path: /var/lib/vault
vault_log_path: /var/log/vault

Konfiguracja TLS Vault
```
vault_enable_tls: false
vault_key: ""
vault_cert: ""
custom_ca: false
vault_ca: ""
vault_dns: ""
```
Aby włączyć konfigurację TLS, ustaw vault_enable_tls na true i podaj klucz prywatny oraz certyfikat publiczny w zmiennych vault_key i vault_cert.

Jeśli do podpisania certyfikatów TLS użyto własnej CA, należy ustawić custom_ca na true i załadować certyfikat CA do zmiennej vault_ca.

Ustaw vault_dns na FQDN serwisu Vault używanego do wydawania certyfikatu.

Można je załadować z plików za pomocą zadania ansible, na przykład:
```
- name: Wczytaj klucz tls i certyfikat z plików
set_fact:
  vault_key: "{{ lookup('file','certificates/{{ inventory_hostname }}_private.key') }}"
  vault_cert: "{{ lookup('file','certificates/{{ inventory_hostname }}_public.crt') }}"
  vault_ca: "{{ lookup('file','certificates/ca.crt') }}"
```
Inicjalizacja Vault
```
vault_init: false
vault_key_shares: 1
vault_key_threshold: 1
vault_keys_output: "{{ vault_config_path }}/unseal.json"
```
Aby automatycznie zainicjalizować Vault, ustaw vault_init na true oraz podaj zmienne vault_key_shares i vault_key_threshold, aby określić liczbę kluczy do odblokowania, które mają zostać wygenerowane.

Inicjalizacja wygeneruje plik json, vault_keys_output, zawierający klucze i token główny.
Odblokowanie Vault i usługa odblokowania
```
vault_unseal: false
vault_unseal_service: false
```
Aby automatycznie odblokować Vault, ustaw vault_unseal na true. Proces odblokowania użyje kluczy z pliku vault_keys_output.

Można utworzyć usługę systemd, aby automatycznie odblokować Vault, gdy usługa Vault jest uruchamiana lub restartowana. Aby to włączyć, ustaw vault_unseal_service na true. Usługa działa jako oneshot vault-unseal. Ta usługa również korzysta z pliku vault_keys_output.
Silnik sekretów KV

Silnik sekretów KV w wersji 2 może być automatycznie włączany poprzez podanie poniższych zmiennych.
```
vault_kv_secrets:
  path: secret
```
KV w wersji 2 zostanie włączony pod ścieżką secret.

Polityki

Polityki ACL mogą być automatycznie konfigurowane, podając nazwę i zawartość HCL.

policies:
  - name: write
    hcl: |
      path "secret/*" {
        capabilities = [ "create", "read", "update", "delete", "list", "patch" ]
      }
  - name: read
    hcl: |
      path "secret/*" {
        capabilities = [ "read" ]
      }

Zależności

Brak

Przykład Playbooka

Poniższy playbook instaluje i konfiguruje Vault, włączając TLS oraz generując certyfikaty SSL podpisane przez własną CA. Inicjalizuje i odblokowuje Vault. Włącza także KV w wersji 2 pod ścieżką secret i tworzy kilka polityk (read i write).

---
- name: Zainstaluj i skonfiguruj serwer Vault
  hosts: vault-server
  become: true
  gather_facts: true
  vars:
    server_hostname: vault.ricsanfre.com
    ssl_key_size: 4096
    key_type: RSA
    country_name: ES
    email_address: [email protected]
    organization_name: Ricsanfre
    ansible_user: root

  pre_tasks:
    - name: Wygeneruj własną CA
      include_tasks: tasks/generate_custom_ca.yml
      args:
        apply:
          delegate_to: localhost
          become: false
    - name: Wygeneruj certyfikaty SSL podpisane przez CA dla minio
      include_tasks: tasks/generate_ca_signed_cert.yml
      args:
        apply:
          delegate_to: localhost
          become: false

    - name: Wczytaj klucz tls i certyfikat
      set_fact:
        vault_key: "{{ lookup('file', 'certificates/' + server_hostname + '.key') }}"
        vault_cert: "{{ lookup('file', 'certificates/' + server_hostname + '.pem') }}"
        vault_ca: "{{ lookup('file', 'certificates/CA.pem') }}"

  roles:
    - role: ricsanfre.vault
      vault_enable_tls: true
      custom_ca: true
      vault_init: true
      vault_unseal: true
      vault_unseal_service: true
      tls_skip_verify: true
      display_init_response: true
      # Konfiguracja KV
      vault_kv_secrets:
        path: secret

      # Polityki
      policies:
        - name: write
          hcl: |
            path "secret/*" {
              capabilities = [ "create", "read", "update", "delete", "list", "patch" ]
            }
        - name: read
          hcl: |
            path "secret/*" {
              capabilities = [ "read" ]
            }

Sekcja pre-tasks zawiera zadania do wygenerowania własnej CA oraz klucza prywatnego i certyfikatu Vault, które są ładowane do zmiennych vault_key, vault_cert oraz vault_ca.

Gdzie generate_custom_ca.yml zawiera zadania do generowania własnej CA:

---
- name: Stwórz klucz CA
  openssl_privatekey:
    path: certificates/CA.key
    size: "{{ ssl_key_size | int }}"
    mode: 0644
  register: ca_key

- name: Stwórz CSR CA
  openssl_csr:
    privatekey_path: certificates/CA.key
    common_name: Ricsanfre CA
    use_common_name_for_san: false  # jako że nie podajemy SAN, nie używaj CN jako SAN
    basic_constraints:
      - 'CA:TRUE'
    basic_constraints_critical: true
    key_usage:
      - keyCertSign
    key_usage_critical: true
    path: certificates/CA.csr
  register: ca_csr

- name: Podpisz CSR CA
  openssl_certificate:
    path: certificates/CA.pem
    csr_path: certificates/CA.csr
    privatekey_path: certificates/CA.key
    provider: selfsigned
  register: ca_crt

A generate_ca_signed_certificate.yml zawiera zadania do generowania klucza Vault i certyfikatu podpisanego przez własną CA:

---
- name: Stwórz klucz prywatny
  openssl_privatekey:
    path: "certificates/{{ server_hostname }}.key"
    size: "{{ ssl_key_size | int }}"
    type: "{{ key_type }}"
    mode: 0644

- name: Stwórz CSR
  openssl_csr:
    path: "certificates/{{ server_hostname }}.csr"
    privatekey_path: "certificates/{{ server_hostname }}.key"
    country_name: "{{ country_name }}"
    organization_name: "{{ organization_name }}"
    email_address: "{{ email_address }}"
    common_name: "{{ server_hostname }}"
    subject_alt_name: "DNS:{{ server_hostname }},IP:{{ ansible_default_ipv4.address }},IP:127.0.0.1"

- name: CSR podpisany przez CA
  openssl_certificate:
    csr_path: "certificates/{{ server_hostname }}.csr"
    path: "certificates/{{ server_hostname }}.pem"
    provider: ownca
    ownca_path: certificates/CA.pem
    ownca_privatekey_path: certificates/CA.key