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
|
#
# 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.
import six
from heat.common import exception
from heat.common.i18n import _
from heat.engine import attributes
from heat.engine import clients
from heat.engine import constraints
from heat.engine import properties
from heat.engine import resource
from heat.openstack.common import log as logging
LOG = logging.getLogger(__name__)
class Secret(resource.Resource):
PROPERTIES = (
NAME, PAYLOAD, PAYLOAD_CONTENT_TYPE, PAYLOAD_CONTENT_ENCODING,
MODE, EXPIRATION, ALGORITHM, BIT_LENGTH,
) = (
'name', 'payload', 'payload_content_type', 'payload_content_encoding',
'mode', 'expiration', 'algorithm', 'bit_length',
)
ATTRIBUTES = (
STATUS, DECRYPTED_PAYLOAD,
) = (
'status', 'decrypted_payload',
)
properties_schema = {
NAME: properties.Schema(
properties.Schema.STRING,
_('Human readable name for the secret.'),
),
PAYLOAD: properties.Schema(
properties.Schema.STRING,
_('The unencrypted plain text of the secret.'),
),
PAYLOAD_CONTENT_TYPE: properties.Schema(
properties.Schema.STRING,
_('The type/format the secret data is provided in.'),
constraints=[
constraints.AllowedValues([
'text/plain',
'application/octet-stream',
]),
],
),
PAYLOAD_CONTENT_ENCODING: properties.Schema(
properties.Schema.STRING,
_('The encoding format used to provide the payload data.'),
default='base64',
constraints=[
constraints.AllowedValues([
'base64',
]),
],
),
EXPIRATION: properties.Schema(
properties.Schema.STRING,
_('The expiration date for the secret in ISO-8601 format.'),
constraints=[
constraints.CustomConstraint('iso_8601'),
],
),
ALGORITHM: properties.Schema(
properties.Schema.STRING,
_('The algorithm type used to generate the secret.'),
),
BIT_LENGTH: properties.Schema(
properties.Schema.NUMBER,
_('The bit-length of the secret.'),
constraints=[
constraints.Range(
min=0,
),
],
),
MODE: properties.Schema(
properties.Schema.STRING,
_('The type/mode of the algorithm associated with the secret '
'information.'),
),
}
attributes_schema = {
STATUS: attributes.Schema(
_('The status of the secret.')
),
DECRYPTED_PAYLOAD: attributes.Schema(
_('The decrypted secret payload.')
),
}
def barbican(self):
return self.client('barbican')
def validate(self):
super(Secret, self).validate()
self._validate_payload()
def _validate_payload(self):
'''Payload is optional, but requires content type if provided.'''
payload = self.properties.get(self.PAYLOAD)
content_type = self.properties.get(self.PAYLOAD_CONTENT_TYPE)
if bool(payload) != bool(content_type):
msg = _("'payload' and 'payload_content_type' must both be "
"provided or omitted.")
raise exception.StackValidationFailed(message=msg)
def handle_create(self):
info = dict(self.properties)
secret = self.barbican().secrets.create(**info)
secret_ref = secret.store()
self.resource_id_set(secret_ref)
return secret_ref
def handle_delete(self):
if not self.resource_id:
return
client = self.barbican()
try:
client.secrets.delete(self.resource_id)
except client.barbican_client.HTTPClientError as exc:
# This is the only exception the client raises
# Inspecting the message to see if it's a 'Not Found'
if 'Not Found' not in six.text_type(exc):
raise
def _resolve_attribute(self, name):
secret = self.barbican().secrets.get(self.resource_id)
if name == self.DECRYPTED_PAYLOAD:
return secret.payload
if name == self.STATUS:
return secret.status
def resource_mapping():
return {
'OS::Barbican::Secret': Secret,
}
def available_resource_mapping():
if not clients.has_client('barbican'):
return {}
return resource_mapping()
|