openstack/barbican
Code Issues Proposed changes

autodoc import error for plugin.rst

Browse Source 
Closes-Bug: 1353645

Change-Id: I0298038418ca771348576b6686069040416a6d8d
This commit is contained in:
Arvind Tiwari 2014-08-06 13:25:56 -06:00
parent 1926fb13d5
commit b80081f18e
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
barbican/plugin/crypto/crypto.py
View File

@ -292,7 +292,7 @@ class CryptoPluginBase(object):
to be decrypted. to be decrypted.
:param kek_meta_dto: Key encryption key metadata to use for decryption :param kek_meta_dto: Key encryption key metadata to use for decryption
:param kek_meta_extended: Optional per-secret KEK metadata to use for :param kek_meta_extended: Optional per-secret KEK metadata to use for
decryption. decryption.
:param keystone_id: keystone_id associated with the encrypted datum. :param keystone_id: keystone_id associated with the encrypted datum.
:returns: str -- unencrypted byte data :returns: str -- unencrypted byte data
@ -331,9 +331,9 @@ class CryptoPluginBase(object):
:param kek_meta_dto: Key encryption key metadata to use for decryption :param kek_meta_dto: Key encryption key metadata to use for decryption
:param keystone_id: keystone_id associated with the data. :param keystone_id: keystone_id associated with the data.
:returns: An object of type ResponseDTO containing encrypted data and :returns: An object of type ResponseDTO containing encrypted data and
kek_meta_extended, the former the resultant cypher text, the latter kek_meta_extended, the former the resultant cypher text, the latter
being optional per-secret metadata needed to decrypt (over and above being optional per-secret metadata needed to decrypt (over and
the per-tenant metadata managed outside of the plugins) above the per-tenant metadata managed outside of the plugins)
""" """
raise NotImplementedError # pragma: no cover raise NotImplementedError # pragma: no cover
@ -349,11 +349,12 @@ class CryptoPluginBase(object):
:param kek_meta_dto: Key encryption key metadata to use for decryption :param kek_meta_dto: Key encryption key metadata to use for decryption
:param keystone_id: keystone_id associated with the data. :param keystone_id: keystone_id associated with the data.
:returns: A tuple containing objects for private_key, public_key and :returns: A tuple containing objects for private_key, public_key and
optionally one for passphrase. The objects will be of type ResponseDTO. optionally one for passphrase. The objects will be of type
Each object containing encrypted data and kek_meta_extended, the former ResponseDTO.
the resultant cypher text, the latter being optional per-secret Each object containing encrypted data and kek_meta_extended, the
metadata needed to decrypt (over and above the per-tenant metadata former the resultant cypher text, the latter being optional
managed outside of the plugins) per-secret metadata needed to decrypt (over and above the
per-tenant metadata managed outside of the plugins)
""" """
raise NotImplementedError # pragma: no cover raise NotImplementedError # pragma: no cover

2
doc/source/plugin.rst
View File

@ -1,4 +1,4 @@
.. module:: barbican.crypto.plugin .. module:: barbican.plugin.crypto.crypto
======================================== ========================================
Cryptographic Backend Plugin Development Cryptographic Backend Plugin Development