/usr/lib/python2.7/dist-packages/barbicanclient/orders.py is in python-barbicanclient 4.0.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 | # Copyright (c) 2013 Rackspace, Inc.
#
# 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 abc
import functools
import logging
from oslo_utils.timeutils import parse_isotime
import six
from barbicanclient import base
from barbicanclient import formatter
LOG = logging.getLogger(__name__)
def immutable_after_save(func):
@functools.wraps(func)
def wrapper(self, *args):
if self._order_ref:
raise base.ImmutableException()
return func(self, *args)
return wrapper
class KeyOrderFormatter(formatter.EntityFormatter):
columns = ("Order href",
"Type",
"Container href",
"Secret href",
"Created",
"Status",
"Error code",
"Error message"
)
def _get_formatted_data(self):
data = (self.order_ref,
"Key",
"N/A",
self.secret_ref,
self.created,
self.status,
self.error_status_code,
self.error_reason
)
return data
class AsymmetricOrderFormatter(formatter.EntityFormatter):
columns = ("Order href",
"Type",
"Container href",
"Secret href",
"Created",
"Status",
"Error code",
"Error message"
)
def _get_formatted_data(self):
data = (self.order_ref,
"Asymmetric",
self.container_ref,
"N/A",
self.created,
self.status,
self.error_status_code,
self.error_reason
)
return data
class CertificateOrderFormatter(formatter.EntityFormatter):
columns = ("Order href",
"Type",
"Container href",
"Secret href",
"Created",
"Status",
"Error code",
"Error message"
)
def _get_formatted_data(self):
data = (self.order_ref,
"Certificate",
self.container_ref,
"N/A",
self.created,
self.status,
self.error_status_code,
self.error_reason
)
return data
@six.add_metaclass(abc.ABCMeta)
class Order(object):
"""
Base order object to hold common functionality
This should be considered an abstract class that should not be
instantiated directly.
"""
_entity = 'orders'
def __init__(self, api, type, status=None, created=None, updated=None,
meta=None, order_ref=None, error_status_code=None,
error_reason=None, sub_status=None, sub_status_message=None,
creator_id=None):
super(Order, self).__init__()
self._api = api
self._type = type
self._status = status
self._sub_status = sub_status
self._sub_status_message = sub_status_message
self._creator_id = creator_id
if created:
self._created = parse_isotime(created)
else:
self._created = None
if updated:
self._updated = parse_isotime(updated)
else:
self._updated = None
self._order_ref = order_ref
self._meta = base.filter_null_keys(meta)
self._error_status_code = error_status_code
self._error_reason = error_reason
if 'expiration' in self._meta.keys():
self._meta['expiration'] = parse_isotime(self._meta['expiration'])
@property
def name(self):
return self._meta.get('name')
@name.setter
@immutable_after_save
def name(self, value):
self._meta['name'] = value
@property
def algorithm(self):
return self._meta.get('algorithm')
@algorithm.setter
@immutable_after_save
def algorithm(self, value):
self._meta['algorithm'] = value
@property
def bit_length(self):
return self._meta.get('bit_length')
@bit_length.setter
@immutable_after_save
def bit_length(self, value):
self._meta['bit_length'] = value
@property
def expiration(self):
return self._meta.get('expiration')
@expiration.setter
@immutable_after_save
def expiration(self, value):
self._meta['expiration'] = value
@property
def payload_content_type(self):
return self._meta.get('payload_content_type')
@payload_content_type.setter
@immutable_after_save
def payload_content_type(self, value):
self._meta['payload_content_type'] = value
@property
def order_ref(self):
return self._order_ref
@property
def created(self):
return self._created
@property
def updated(self):
return self._updated
@property
def status(self):
return self._status
@property
def error_status_code(self):
return self._error_status_code
@property
def error_reason(self):
return self._error_reason
@immutable_after_save
def submit(self):
"""
Submit the Order to Barbican. New Order objects are not persisted
in Barbican until this method is called.
"""
order_dict = {'type': self._type, 'meta': self._meta}
LOG.debug("Request body: {0}".format(order_dict))
response = self._api.post(self._entity, json=order_dict)
if response:
self._order_ref = response.get('order_ref')
return self._order_ref
def delete(self):
"""
Deletes the Order from Barbican
"""
if self._order_ref:
self._api.delete(self._order_ref)
self._order_ref = None
else:
raise LookupError("Order is not yet stored.")
class KeyOrder(Order, KeyOrderFormatter):
"""
KeyOrders can be used to request random key material from Barbican
"""
_type = 'key'
def __init__(self, api, name=None, algorithm=None, bit_length=None,
mode=None, expiration=None, payload_content_type=None,
status=None, created=None, updated=None, order_ref=None,
secret_ref=None, error_status_code=None, error_reason=None,
sub_status=None, sub_status_message=None, creator_id=None):
super(KeyOrder, self).__init__(
api, self._type, status=status, created=created, updated=updated,
meta={
'name': name, 'algorithm': algorithm, 'bit_length': bit_length,
'expiration': expiration,
'payload_content_type': payload_content_type
}, order_ref=order_ref, error_status_code=error_status_code,
error_reason=error_reason, sub_status=sub_status,
sub_status_message=sub_status_message, creator_id=creator_id)
self._secret_ref = secret_ref
if mode:
self._meta['mode'] = mode
@property
def mode(self):
"""Encryption mode being used with this key
The mode could be set to "CBC" for example, when requesting a key that
will be used for AES encryption in CBC mode.
"""
return self._meta.get('mode')
@property
def secret_ref(self):
return self._secret_ref
@mode.setter
@immutable_after_save
def mode(self, value):
self._meta['mode'] = value
def __repr__(self):
return 'KeyOrder(order_ref={0})'.format(self.order_ref)
class AsymmetricOrder(Order, AsymmetricOrderFormatter):
_type = 'asymmetric'
def __init__(self, api, name=None, algorithm=None, bit_length=None,
mode=None, pass_phrase=None, expiration=None,
payload_content_type=None, status=None, created=None,
updated=None, order_ref=None, container_ref=None,
error_status_code=None, error_reason=None, sub_status=None,
sub_status_message=None, creator_id=None):
super(AsymmetricOrder, self).__init__(
api, self._type, status=status, created=created, updated=updated,
meta={
'name': name, 'algorithm': algorithm, 'bit_length': bit_length,
'expiration': expiration,
'payload_content_type': payload_content_type
}, order_ref=order_ref, error_status_code=error_status_code,
error_reason=error_reason, sub_status=sub_status,
sub_status_message=sub_status_message, creator_id=creator_id)
self._container_ref = container_ref
if pass_phrase:
self._meta['pass_phrase'] = pass_phrase
@property
def container_ref(self):
return self._container_ref
@property
def pass_phrase(self):
"""Passphrase to be used for passphrase protected asymmetric keys
"""
return self._meta.get('pass_phrase')
@pass_phrase.setter
@immutable_after_save
def pass_phrase(self, value):
self._meta['pass_phrase'] = value
def __repr__(self):
return 'AsymmetricOrder(order_ref={0})'.format(self.order_ref)
class CertificateOrder(Order, CertificateOrderFormatter):
_type = 'certificate'
def __init__(self, api, name=None,
status=None, created=None, updated=None, order_ref=None,
container_ref=None, error_status_code=None, error_reason=None,
sub_status=None, sub_status_message=None, creator_id=None,
request_type=None, subject_dn=None,
source_container_ref=None, ca_id=None, profile=None,
request_data=None):
super(CertificateOrder, self).__init__(
api, self._type, status=status, created=created, updated=updated,
meta={
'name': name,
'request_type': request_type,
'subject_dn': subject_dn,
'container_ref': source_container_ref,
'ca_id': ca_id,
'profile': profile,
'request_data': request_data
}, order_ref=order_ref, error_status_code=error_status_code,
error_reason=error_reason)
self._container_ref = container_ref
@property
def container_ref(self):
return self._container_ref
def __repr__(self):
return 'CertificateOrder(order_ref={0})'.format(self.order_ref)
class OrderManager(base.BaseEntityManager):
"""
Entity Manager for Order entitites
"""
_order_type_to_class_map = {
'key': KeyOrder,
'asymmetric': AsymmetricOrder,
'certificate': CertificateOrder
}
def __init__(self, api):
super(OrderManager, self).__init__(api, 'orders')
def get(self, order_ref):
"""
Retrieve an existing Order from Barbican
:param order_ref: Full HATEOAS reference to an Order
:returns: An instance of the appropriate subtype of Order
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
"""
LOG.debug("Getting order - Order href: {0}".format(order_ref))
base.validate_ref(order_ref, 'Order')
try:
response = self._api.get(order_ref)
except AttributeError:
raise LookupError(
'Order {0} could not be found.'.format(order_ref)
)
return self._create_typed_order(response)
def _create_typed_order(self, response):
resp_type = response.pop('type').lower()
order_type = self._order_type_to_class_map.get(resp_type)
if (resp_type == 'certificate' and
'container_ref' in response.get('meta', ())):
response['source_container_ref'] = response['meta'].pop(
'container_ref')
response.update(response.pop('meta'))
if order_type is not None:
return order_type(self._api, **response)
else:
raise TypeError('Unknown Order type "{0}"'.format(order_type))
def create(self, type=None, **kwargs):
if not type:
raise TypeError('No Order type provided')
order_type = self._order_type_to_class_map.get(type.lower())
if not order_type:
raise TypeError('Unknown Order type "{0}"'.format(type))
return order_type(self._api, **kwargs)
def create_key(self, name=None, algorithm=None, bit_length=None, mode=None,
payload_content_type=None, expiration=None):
"""
Factory method for `KeyOrder` objects
`KeyOrder` objects returned by this method have not yet been submitted
to the Barbican service.
:param name: A friendly name for the secret to be created
:param algorithm: The algorithm associated with this secret key
:param bit_length: The bit length of this secret key
:param mode: The algorithm mode used with this secret key
:param payload_content_type: The format/type of the secret data
:param expiration: The expiration time of the secret in ISO 8601 format
:returns: KeyOrder
:rtype: :class:`barbicanclient.orders.KeyOrder`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
"""
return KeyOrder(api=self._api, name=name,
algorithm=algorithm, bit_length=bit_length, mode=mode,
payload_content_type=payload_content_type,
expiration=expiration)
def create_asymmetric(self, name=None, algorithm=None, bit_length=None,
pass_phrase=None, payload_content_type=None,
expiration=None):
"""
Factory method for `AsymmetricOrder` objects
`AsymmetricOrder` objects returned by this method have not yet been
submitted to the Barbican service.
:param name: A friendly name for the container to be created
:param algorithm: The algorithm associated with this secret key
:param bit_length: The bit length of this secret key
:param pass_phrase: Optional passphrase
:param payload_content_type: The format/type of the secret data
:param expiration: The expiration time of the secret in ISO 8601 format
:returns: AsymmetricOrder
:rtype: :class:`barbicanclient.orders.AsymmetricOrder`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
"""
return AsymmetricOrder(api=self._api, name=name, algorithm=algorithm,
bit_length=bit_length, pass_phrase=pass_phrase,
payload_content_type=payload_content_type,
expiration=expiration)
def create_certificate(self, name=None, request_type=None, subject_dn=None,
source_container_ref=None, ca_id=None,
profile=None, request_data=None):
"""
Factory method for `CertificateOrder` objects
`CertificateOrder` objects returned by this method have not yet been
submitted to the Barbican service.
:param name: A friendly name for the container to be created
:param request_type: The type of the certificate request
:param subject_dn: A subject for the certificate
:param source_container_ref: A container with a public/private key pair
to use as source for stored-key requests
:param ca_id: The identifier of the CA to use
:param profile: The profile of certificate to use
:param request_data: The CSR content
:returns: CertificateOrder
:rtype: :class:`barbicanclient.orders.CertificateOrder`
"""
return CertificateOrder(api=self._api, name=name,
request_type=request_type,
subject_dn=subject_dn,
source_container_ref=source_container_ref,
ca_id=ca_id,
profile=profile,
request_data=request_data)
def delete(self, order_ref):
"""
Delete an Order from Barbican
:param order_ref: The href for the order
"""
if not order_ref:
raise ValueError('order_ref is required.')
self._api.delete(order_ref)
def list(self, limit=10, offset=0):
"""
List Orders for the project
This method uses the limit and offset parameters for paging.
:param limit: Max number of orders returned
:param offset: Offset orders to begin list
:returns: list of Order objects
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
"""
LOG.debug('Listing orders - offset {0} limit {1}'.format(offset,
limit))
params = {'limit': limit, 'offset': offset}
response = self._api.get(self._entity, params=params)
return [
self._create_typed_order(o) for o in response.get('orders', [])
]
|