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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Command-line interface sub-commands related to secrets.
"""
import os
from cliff import command
from cliff import lister
from cliff import show
from barbicanclient.v1 import secrets
class DeleteSecret(command.Command):
"""Delete a secret by providing its URI."""
def get_parser(self, prog_name):
parser = super(DeleteSecret, self).get_parser(prog_name)
parser.add_argument('URI', help='The URI reference for the secret')
parser.add_argument('--force', '-f',
default=False,
help='if specified, forces the '
'deletion of secrets that have consumers.',
action='store_true')
return parser
def take_action(self, args):
self.app.client_manager.key_manager.secrets.delete(
args.URI, args.force)
class GetSecret(show.ShowOne):
"""Retrieve a secret by providing its URI."""
def get_parser(self, prog_name):
parser = super(GetSecret, self).get_parser(prog_name)
parser.add_argument('URI', help='The URI reference for the secret.')
payload_params = parser.add_mutually_exclusive_group(required=False)
payload_params.add_argument('--decrypt', '-d',
help='if specified, retrieve the '
'unencrypted secret data.',
action='store_true')
payload_params.add_argument('--payload', '-p',
help='if specified, retrieve the '
'unencrypted secret data.',
action='store_true')
payload_params.add_argument('--file', '-F', metavar='<filename>',
help='if specified, save the payload to a '
'new file with the given filename.')
parser.add_argument('--payload_content_type', '-t',
default='text/plain',
help='the content type of the decrypted'
' secret (default: %(default)s).')
return parser
def take_action(self, args):
if args.decrypt or args.payload or args.file:
entity = self.app.client_manager.key_manager.secrets.get(
args.URI, args.payload_content_type)
return (('Payload',),
(entity.payload,))
else:
entity = self.app.client_manager.key_manager.secrets.get(
secret_ref=args.URI)
return entity._get_formatted_entity()
def produce_output(self, parsed_args, column_names, data):
if parsed_args.file:
if os.path.exists(parsed_args.file):
raise ValueError("ERROR: file already exists.")
# String should be encoded to bytes in Python3
secret = data[0].encode('utf-8') if isinstance(data[0], str) \
else data[0]
with open(parsed_args.file, 'wb') as f:
f.write(secret)
else:
super(GetSecret, self).produce_output(
parsed_args, column_names, data
)
class UpdateSecret(command.Command):
"""Update a secret with no payload in Barbican."""
def get_parser(self, prog_name):
parser = super(UpdateSecret, self).get_parser(prog_name)
parser.add_argument('URI', help='The URI reference for the secret.')
parser.add_argument('payload', help='the unencrypted secret')
return parser
def take_action(self, args):
self.app.client_manager.key_manager.secrets.update(args.URI,
args.payload)
class ListSecret(lister.Lister):
"""List secrets."""
def get_parser(self, prog_name):
parser = super(ListSecret, self).get_parser(prog_name)
parser.add_argument('--limit', '-l', default=10,
help='specify the limit to the number of items '
'to list per page (default: %(default)s; '
'maximum: 100)',
type=int)
parser.add_argument('--offset', '-o', default=0,
help='specify the page offset '
'(default: %(default)s)',
type=int)
parser.add_argument('--name', '-n', default=None,
help='specify the secret name '
'(default: %(default)s)')
parser.add_argument('--algorithm', '-a', default=None,
help='the algorithm filter for the list'
'(default: %(default)s).')
parser.add_argument('--bit-length', '-b', default=0,
help='the bit length filter for the list'
' (default: %(default)s).',
type=int)
parser.add_argument('--mode', '-m', default=None,
help='the algorithm mode filter for the'
' list (default: %(default)s).')
parser.add_argument('--secret-type', '-s', default=None,
help='specify the secret type '
'(default: %(default)s).')
return parser
def take_action(self, args):
obj_list = self.app.client_manager.key_manager.secrets.list(
limit=args.limit, offset=args.offset, name=args.name,
algorithm=args.algorithm, mode=args.mode, bits=args.bit_length,
secret_type=args.secret_type)
return secrets.Secret._list_objects(obj_list)
class StoreSecret(show.ShowOne):
"""Store a secret in Barbican."""
def get_parser(self, prog_name):
parser = super(StoreSecret, self).get_parser(prog_name)
parser.add_argument('--name', '-n',
help='a human-friendly name.')
parser.add_argument('--secret-type', '-s', default='opaque',
help='the secret type; must be one of symmetric, '
'public, private, certificate, passphrase, '
'opaque (default)')
parser.add_argument('--payload-content-type', '-t',
help='the type/format of the provided '
'secret data; "text/plain" is assumed to be '
'UTF-8; required when --payload is '
'supplied.')
parser.add_argument('--payload-content-encoding', '-e',
help='required if --payload-content-type is '
'"application/octet-stream".')
parser.add_argument('--algorithm', '-a', default='aes',
help='the algorithm (default: '
'%(default)s).')
parser.add_argument('--bit-length', '-b', default=256,
help='the bit length '
'(default: %(default)s).',
type=int)
parser.add_argument('--mode', '-m', default='cbc',
help='the algorithm mode; used only for '
'reference (default: %(default)s)')
parser.add_argument('--expiration', '-x',
help='the expiration time for the secret in '
'ISO 8601 format.')
payload_params = parser.add_mutually_exclusive_group(required=False)
payload_params.add_argument('--payload', '-p',
help='the unencrypted secret data.')
payload_params.add_argument('--file', '-F', metavar='<filename>',
help='file containing the secret payload')
return parser
def take_action(self, args):
data = None
if args.file:
with open(args.file, 'rb') as f:
data = f.read()
payload = args.payload.encode('utf-8') if args.payload else data
entity = self.app.client_manager.key_manager.secrets.create(
name=args.name, payload=payload,
payload_content_type=args.payload_content_type,
payload_content_encoding=args.payload_content_encoding,
algorithm=args.algorithm, bit_length=args.bit_length,
mode=args.mode, expiration=args.expiration,
secret_type=args.secret_type)
entity.store()
return entity._get_formatted_entity()
class CreateConsumer(command.Command):
"""Create a consumer for a secret."""
def get_parser(self, prog_name):
parser = super(CreateConsumer, self).get_parser(prog_name)
parser.add_argument('URI', help='The URI reference for the secret')
parser.add_argument('--service-type-name', '-s', required=True,
help='the service that will consume the secret')
parser.add_argument('--resource-type', '-t', required=True,
help='the type of resource that will consume '
'the secret')
parser.add_argument('--resource-id', '-i', required=True,
help='the id of the resource that will consume '
'the secret')
return parser
def take_action(self, args):
self.app.client_manager.key_manager.secrets.register_consumer(
args.URI,
args.service_type_name,
args.resource_type,
args.resource_id)
class DeleteConsumer(command.Command):
"""Delete a consumer from a secret."""
def get_parser(self, prog_name):
parser = super(DeleteConsumer, self).get_parser(prog_name)
parser.add_argument('URI', help='The URI reference for the secret')
parser.add_argument('--service-type-name', '-s', required=True,
help='the service that is consuming the secret')
parser.add_argument('--resource-type', '-t', required=True,
help='the type of resource that is consuming '
'the secret')
parser.add_argument('--resource-id', '-i', required=True,
help='the id of the resource that is consuming '
'the secret')
return parser
def take_action(self, args):
self.app.client_manager.key_manager.secrets.remove_consumer(
args.URI,
args.service_type_name,
args.resource_type,
args.resource_id)
class ListConsumer(lister.Lister):
"""List consumers of a secret."""
def get_parser(self, prog_name):
parser = super(ListConsumer, self).get_parser(prog_name)
parser.add_argument('URI', help='The URI reference for the secret')
parser.add_argument('--limit', '-l', default=10,
help='specify the limit to the number of items '
'to list per page (default: %(default)s; '
'maximum: 100)',
type=int)
parser.add_argument('--offset', '-o', default=0,
help='specify the page offset '
'(default: %(default)s)',
type=int)
return parser
def take_action(self, args):
obj_list = self.app.client_manager.key_manager.secrets.list_consumers(
secret_ref=args.URI, limit=args.limit, offset=args.offset)
return secrets.SecretConsumers._list_objects(obj_list)
|
