forked from warolv/vault-backup
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vault_handler.py
211 lines (179 loc) · 6.14 KB
/
vault_handler.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
#! /usr/bin/env python
# -*- coding: utf-8 -*-
#
# Backup/create encrypted/not encrypted dumps from HashiCorps's Vault secrets to json/yaml dumps
# Populate Vault from json/yaml dump
#
# ENV variables:
# VAULT_ADDR: for example: 'http://vault.vault.svc.cluster.local:8200' for k8s cluster
# ROLE_ID: RoleID for AppRole auth
# SECRET_ID: SecretID for AppRole auth
# VAULT_PREFIX: for example 'jenkins'
# DUMP_ENCRYPTION_PASSWORD: password which will be used for secrets dump encryption
#
# Copyright (c) 2021 Igor Zhivilo <igor.zhivilo@gmail.com>
# Licensed under the MIT License
import json
import os
import click
import hvac
from cryptography.fernet import Fernet
VAULT_ADDR = os.environ.get('VAULT_ADDR')
ROLE_ID = os.environ.get('ROLE_ID')
SECRET_ID = os.environ.get('SECRET_ID')
VAULT_PREFIX = os.environ.get('VAULT_PREFIX')
ENCRYPTION_KEY = os.environ.get('ENCRYPTION_KEY')
class VaultHandler:
def __init__(self, url, role_id, secret_id, path, enc_key):
self.url = url
self.role_id = role_id
self.secret_id = secret_id
self.path = path
self.enc_key = enc_key
self.client = hvac.Client(url=self.url)
self.client.auth.approle.login(
role_id=self.role_id,
secret_id=self.secret_id,
)
if not self.client.is_authenticated():
raise Exception('Vault authentication error!')
def get_secrets_list(self):
secrets_list_response = self.client.secrets.kv.v2.list_secrets(
path='{}'.format(self.path),
)
return secrets_list_response['data']['keys']
def print_all_secrets_with_metadata(self):
for key in self.get_secrets_list():
print('\nKey is: {}'.format(key))
secret_response = self.get_secret(key)
print(secret_response)
def _secrets_to_dict(self):
secrets_dict = {}
for key in self.get_secrets_list():
secret_response = self.get_secret(key)
secret_data = {}
for k in secret_response['data']['data'].keys():
secret_data = secret_response['data']['data'].copy()
secrets_dict[key] = secret_data
return secrets_dict
def get_secret(self, key):
return self.client.secrets.kv.v2.read_secret(
path='{}/{}'.format(self.path, key),
)
def print_secrets_nicely(self, secrets_dict={}):
if not secrets_dict:
secrets_dict = self._secrets_to_dict()
for secret_name, secret in secrets_dict.items():
print('\n{}'.format(secret_name))
for attr_name, attr in secret.items():
print(attr_name, ':', attr)
def dump_all_secrets(self, dump_path):
secrets_dict = self._secrets_to_dict()
self._encrypt_dump(secrets_dict, dump_path)
def _encrypt_dump(self, secrets_dict, dump_path):
f = Fernet(self.enc_key)
secrets_dict_byte = json.dumps(secrets_dict).encode('utf-8')
encrypted_data = f.encrypt(secrets_dict_byte)
with open(dump_path, 'wb') as file:
file.write(encrypted_data)
def _decrypt_dump(self, path_to_dump):
f = Fernet(self.enc_key)
with open(path_to_dump, 'rb') as file:
file_data = file.read()
decrypted_data = f.decrypt(file_data).decode('utf-8')
return json.loads(decrypted_data)
def print_secrets_from_encrypted_dump(self, path_to_dump):
decrypted_data = self._decrypt_dump(path_to_dump)
self.print_secrets_nicely(decrypted_data)
def _populate_vault_prefix_from_dict(self, secrets_dict, vault_prefix_to_populate):
for key in secrets_dict:
self.client.secrets.kv.v2.create_or_update_secret(
path='{}/{}'.format(vault_prefix_to_populate, key),
secret=secrets_dict[key],
)
def populate_vault_from_dump(self, vault_prefix_to_populate, path_to_dump):
secrets_dict = self._decrypt_dump(path_to_dump)
self._populate_vault_prefix_from_dict(
secrets_dict, vault_prefix_to_populate,
)
@click.group(invoke_without_command=True)
@click.pass_context
def main(ctx):
group_commands = ['print', 'print-dump', 'dump', 'populate']
"""
VaultHandler is a command line tool that helps dump/populate secrets of HashiCorp's Vault
"""
if ctx.invoked_subcommand is None:
click.echo('Specify one of the commands below')
print(*group_commands, sep='\n')
@main.command('print')
@click.pass_context
def print_secrets(ctx):
"""
Print secrets nicely.
"""
vault = VaultHandler(
VAULT_ADDR, ROLE_ID, SECRET_ID,
VAULT_PREFIX, ENCRYPTION_KEY,
)
vault.print_secrets_nicely()
@main.command('print-dump')
@click.pass_context
@click.option(
'--dump_path', '-dp',
type=str,
default='vault_secrets.enc',
help='Path/name of dump with secrets',
)
def print_dump(ctx, dump_path):
"""
Print secrets from encrypted dump.
"""
vault = VaultHandler(
VAULT_ADDR, ROLE_ID, SECRET_ID,
VAULT_PREFIX, ENCRYPTION_KEY,
)
vault.print_secrets_from_encrypted_dump(dump_path)
@main.command('dump')
@click.pass_context
@click.option(
'--dump_path', '-dp',
type=str,
default='vault_secrets.enc',
help='Path/name of dump with secrets',
)
def dump_secrets(ctx, dump_path):
"""
Dump secrets from Vault.
"""
vault = VaultHandler(
VAULT_ADDR, ROLE_ID, SECRET_ID,
VAULT_PREFIX, ENCRYPTION_KEY,
)
vault.dump_all_secrets(dump_path)
@main.command('populate')
@click.pass_context
@click.option(
'--vault_prefix', '-vp',
type=str,
required=True,
help="Vault's prefix to populate from secrets dump",
)
@click.option(
'--dump_path', '-dp',
type=str,
default='vault_secrets.enc',
help='Path to dump with secrets',
)
def populate_vault_prefix(ctx, vault_prefix, dump_path):
"""
Populate Vault prefix from dump with secrets.
"""
vault = VaultHandler(
VAULT_ADDR, ROLE_ID, SECRET_ID,
VAULT_PREFIX, ENCRYPTION_KEY,
)
vault.populate_vault_from_dump(vault_prefix, dump_path)
# pylint:disable=no-value-for-parameter
if __name__ == '__main__':
main(obj={})