Browse Source
The barbican-hsm-plugin interface provides a mechanism for the Barbican charm to communicate with an HSM plugin. The plugin (from the Barbican perspective) is provided as a PKCS#11 compliant library (.so) and so is local to the Barbican installation. Thus, the hsm-plugin charms are subordinate to the Barbican charm and run on the same unit. This change also provides two actions (generate-mkek and generate-hmac) which are 'one-off' operations to initialise the HSM with the global master keys. Add a note to the README that the generate-mkek and generate-hmac actions may only be done once as the HSM may reject overwriting the key. Add Apache2.0 LICENSE and license headers to files Removed redundant copyright file Change the reference for the internal port to 9311 The barbican project changed the INTERNAL port to the same as the PUBLIC port. Add in seed_file and seed_length to template. These are needed for a change in Barbican to support seeding the RNG in the HSM if required. They are set to /dev/random and 32. Fetch the barbican sources from a PPA (for bug: 1599550) Remove the trusty support for Py3 from install hookchanges/57/350257/1
Alex Kavanagh
6 years ago
26 changed files with 990 additions and 158 deletions
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License |
||||
Version 2.0, January 2004 |
||||
http://www.apache.org/licenses/ |
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||
|
||||
1. Definitions. |
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, |
||||
and distribution as defined by Sections 1 through 9 of this document. |
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by |
||||
the copyright owner that is granting the License. |
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all |
||||
other entities that control, are controlled by, or are under common |
||||
control with that entity. For the purposes of this definition, |
||||
"control" means (i) the power, direct or indirect, to cause the |
||||
direction or management of such entity, whether by contract or |
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||
outstanding shares, or (iii) beneficial ownership of such entity. |
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity |
||||
exercising permissions granted by this License. |
||||
|
||||
"Source" form shall mean the preferred form for making modifications, |
||||
including but not limited to software source code, documentation |
||||
source, and configuration files. |
||||
|
||||
"Object" form shall mean any form resulting from mechanical |
||||
transformation or translation of a Source form, including but |
||||
not limited to compiled object code, generated documentation, |
||||
and conversions to other media types. |
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or |
||||
Object form, made available under the License, as indicated by a |
||||
copyright notice that is included in or attached to the work |
||||
(an example is provided in the Appendix below). |
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object |
||||
form, that is based on (or derived from) the Work and for which the |
||||
editorial revisions, annotations, elaborations, or other modifications |
||||
represent, as a whole, an original work of authorship. For the purposes |
||||
of this License, Derivative Works shall not include works that remain |
||||
separable from, or merely link (or bind by name) to the interfaces of, |
||||
the Work and Derivative Works thereof. |
||||
|
||||
"Contribution" shall mean any work of authorship, including |
||||
the original version of the Work and any modifications or additions |
||||
to that Work or Derivative Works thereof, that is intentionally |
||||
submitted to Licensor for inclusion in the Work by the copyright owner |
||||
or by an individual or Legal Entity authorized to submit on behalf of |
||||
the copyright owner. For the purposes of this definition, "submitted" |
||||
means any form of electronic, verbal, or written communication sent |
||||
to the Licensor or its representatives, including but not limited to |
||||
communication on electronic mailing lists, source code control systems, |
||||
and issue tracking systems that are managed by, or on behalf of, the |
||||
Licensor for the purpose of discussing and improving the Work, but |
||||
excluding communication that is conspicuously marked or otherwise |
||||
designated in writing by the copyright owner as "Not a Contribution." |
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||
on behalf of whom a Contribution has been received by Licensor and |
||||
subsequently incorporated within the Work. |
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
copyright license to reproduce, prepare Derivative Works of, |
||||
publicly display, publicly perform, sublicense, and distribute the |
||||
Work and such Derivative Works in Source or Object form. |
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
(except as stated in this section) patent license to make, have made, |
||||
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||
where such license applies only to those patent claims licensable |
||||
by such Contributor that are necessarily infringed by their |
||||
Contribution(s) alone or by combination of their Contribution(s) |
||||
with the Work to which such Contribution(s) was submitted. If You |
||||
institute patent litigation against any entity (including a |
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||
or a Contribution incorporated within the Work constitutes direct |
||||
or contributory patent infringement, then any patent licenses |
||||
granted to You under this License for that Work shall terminate |
||||
as of the date such litigation is filed. |
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the |
||||
Work or Derivative Works thereof in any medium, with or without |
||||
modifications, and in Source or Object form, provided that You |
||||
meet the following conditions: |
||||
|
||||
(a) You must give any other recipients of the Work or |
||||
Derivative Works a copy of this License; and |
||||
|
||||
(b) You must cause any modified files to carry prominent notices |
||||
stating that You changed the files; and |
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works |
||||
that You distribute, all copyright, patent, trademark, and |
||||
attribution notices from the Source form of the Work, |
||||
excluding those notices that do not pertain to any part of |
||||
the Derivative Works; and |
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its |
||||
distribution, then any Derivative Works that You distribute must |
||||
include a readable copy of the attribution notices contained |
||||
within such NOTICE file, excluding those notices that do not |
||||
pertain to any part of the Derivative Works, in at least one |
||||
of the following places: within a NOTICE text file distributed |
||||
as part of the Derivative Works; within the Source form or |
||||
documentation, if provided along with the Derivative Works; or, |
||||
within a display generated by the Derivative Works, if and |
||||
wherever such third-party notices normally appear. The contents |
||||
of the NOTICE file are for informational purposes only and |
||||
do not modify the License. You may add Your own attribution |
||||
notices within Derivative Works that You distribute, alongside |
||||
or as an addendum to the NOTICE text from the Work, provided |
||||
that such additional attribution notices cannot be construed |
||||
as modifying the License. |
||||
|
||||
You may add Your own copyright statement to Your modifications and |
||||
may provide additional or different license terms and conditions |
||||
for use, reproduction, or distribution of Your modifications, or |
||||
for any such Derivative Works as a whole, provided Your use, |
||||
reproduction, and distribution of the Work otherwise complies with |
||||
the conditions stated in this License. |
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||
any Contribution intentionally submitted for inclusion in the Work |
||||
by You to the Licensor shall be under the terms and conditions of |
||||
this License, without any additional terms or conditions. |
||||
Notwithstanding the above, nothing herein shall supersede or modify |
||||
the terms of any separate license agreement you may have executed |
||||
with Licensor regarding such Contributions. |
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade |
||||
names, trademarks, service marks, or product names of the Licensor, |
||||
except as required for reasonable and customary use in describing the |
||||
origin of the Work and reproducing the content of the NOTICE file. |
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or |
||||
agreed to in writing, Licensor provides the Work (and each |
||||
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
implied, including, without limitation, any warranties or conditions |
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||
appropriateness of using or redistributing the Work and assume any |
||||
risks associated with Your exercise of permissions under this License. |
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory, |
||||
whether in tort (including negligence), contract, or otherwise, |
||||
unless required by applicable law (such as deliberate and grossly |
||||
negligent acts) or agreed to in writing, shall any Contributor be |
||||
liable to You for damages, including any direct, indirect, special, |
||||
incidental, or consequential damages of any character arising as a |
||||
result of this License or out of the use or inability to use the |
||||
Work (including but not limited to damages for loss of goodwill, |
||||
work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses), even if such Contributor |
||||
has been advised of the possibility of such damages. |
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing |
||||
the Work or Derivative Works thereof, You may choose to offer, |
||||
and charge a fee for, acceptance of support, warranty, indemnity, |
||||
or other liability obligations and/or rights consistent with this |
||||
License. However, in accepting such obligations, You may act only |
||||
on Your own behalf and on Your sole responsibility, not on behalf |
||||
of any other Contributor, and only if You agree to indemnify, |
||||
defend, and hold each Contributor harmless for any liability |
||||
incurred by, or claims asserted against, such Contributor by reason |
||||
of your accepting any such warranty or additional liability. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
APPENDIX: How to apply the Apache License to your work. |
||||
|
||||
To apply the Apache License to your work, attach the following |
||||
boilerplate notice, with the fields enclosed by brackets "[]" |
||||
replaced with your own identifying information. (Don't include |
||||
the brackets!) The text should be enclosed in the appropriate |
||||
comment syntax for the file format. We also recommend that a |
||||
file or class name and description of purpose be included on the |
||||
same "printed page" as the copyright notice for easier |
||||
identification within third-party archives. |
||||
|
||||
Copyright [yyyy] [name of copyright owner] |
||||
|
||||
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. |
||||
@ -0,0 +1,87 @@
|
||||
# Barbican Source Charm |
||||
|
||||
This repository is for the reactive, layered, |
||||
[Barbican](https://wiki.openstack.org/wiki/Barbican) _source_ charm. From the |
||||
[wiki](https://wiki.openstack.org/wiki/Barbican) 'Barbican is a REST API |
||||
designed for the secure storage, provisioning and management of secrets such as |
||||
passwords, encryption keys and X.509 Certificates. It is aimed at being useful |
||||
for all environments, including large ephemeral Clouds.' |
||||
|
||||
# Plugins |
||||
|
||||
The Barbican charm currently supports the following plugins: |
||||
|
||||
- [charm-barbican-softhsm-plugin](https://github.com/openstack/charm-barbican-softhsm-plugin) |
||||
|
||||
# Creating the primary MKEK and primary HMAC |
||||
|
||||
Barbican (can use|uses) a Master Key Encryption Key (MKEK) scheme to wrap other |
||||
keys so that in the course of issuing new encryption keys, it doesn't exhaust |
||||
the storage capacity of an HSM. |
||||
|
||||
See [KMIP MKEK Model |
||||
Plugin](https://specs.openstack.org/openstack/barbican-specs/specs/kilo/barbican-mkek-model.html) |
||||
for more details. |
||||
|
||||
Barbican itself can generate the MKEK and HMAC keys and store them in the |
||||
associated HSM through the use of two actions 'generate-mkek' and |
||||
'generate-hmac'. |
||||
|
||||
The names of the keys are stored in the configuration for the service as |
||||
'mkek-label' and 'hmac-label'. These default to 'primarymkek' and |
||||
'primaryhmac' respectively. |
||||
|
||||
Note that these keys are not recoverable _from_ the HSM. If the HSM has |
||||
already been configured with these keys then these actions would overwrite the |
||||
existing key. So only use them for the initial implementation or to change the |
||||
MKEK and HMAC keys in the HSM. |
||||
|
||||
## Use of actions |
||||
|
||||
For juju 1.x: |
||||
```bash |
||||
juju action do generate-mkek |
||||
``` |
||||
|
||||
For juju 2.x: |
||||
|
||||
```bash |
||||
juju run-action generate-mkek |
||||
``` |
||||
|
||||
Note that, depending on the HSM, it may only be possible to do this ONCE as the |
||||
HSM may reject setting up the keys more than once. |
||||
|
||||
# Developer Notes |
||||
|
||||
The Barbican charm has to be able to set `[crypto]` and `[xxx_plugin]` sections |
||||
in the `barbican-api.conf` file. This data comes via the `barbican-hsm-plugin` |
||||
interface from a charm (probably a subordinate) that provides the interface. |
||||
|
||||
On the `barbican-hsm-interface` the data is provided in the `plugin_data()` |
||||
method of the interface (or if it is adapted) in the `plugin_data` property. |
||||
|
||||
The theory of operation for the crypto plugin is that a local library that |
||||
supports the PKCS#11 interface that Barbican can talk to locally. |
||||
|
||||
Note(AJK): it is not clear yet how a clustered Barbican can be created with |
||||
a single HSM backend. It's likely to be a separate piece of hardward with |
||||
a local library that talks to it. |
||||
|
||||
In order for Barbican to be configured for the example softhsm2 library, the |
||||
configuration file needs to include the entries: |
||||
|
||||
```ini |
||||
[crypto] |
||||
enabled_crypto_plugins = p11_crypto |
||||
|
||||
[p11_crypto_plugin] |
||||
library_path = '/usr/lib/libCryptoki2_64.so' |
||||
login = 'catt' |
||||
mkek_label = 'primarymkek' |
||||
mkek_length = 32 |
||||
hmac_label = 'primaryhmac' slot_id = <slot_id> |
||||
``` |
||||
|
||||
Note that the /var/lib/softhsm/tokens directory HAS to exist as otherwise the |
||||
softhsm2-util command won't work. |
||||
@ -1,13 +0,0 @@
|
||||
Copyright 2016 Canonical Ltd. |
||||
|
||||
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. |
||||
@ -0,0 +1,8 @@
|
||||
generate-mkek: |
||||
description: | |
||||
Generate an MKEK in the associated HSM (via the barbican-hsm-plugin |
||||
interface). |
||||
generate-hmac: |
||||
description: | |
||||
Generate an HMAC in the associated HSM (via the barbican-hsm-plugin |
||||
interface). |
||||
@ -0,0 +1,82 @@
|
||||
#!/usr/bin/env python3 |
||||
# Copyright 2016 Canonical Ltd |
||||
# |
||||
# 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 os |
||||
import sys |
||||
|
||||
# Load modules from $CHARM_DIR/lib |
||||
sys.path.append('lib') |
||||
|
||||
from charms.layer import basic |
||||
basic.bootstrap_charm_deps() |
||||
basic.init_config_states() |
||||
|
||||
import charms.reactive as reactive |
||||
|
||||
import charmhelpers.core.hookenv as hookenv |
||||
|
||||
import charm.openstack.barbican as barbican |
||||
|
||||
|
||||
def generate_mkek_action(*args): |
||||
"""Generate an MKEK in the backend HSM""" |
||||
# try and get the reactive relation instance for hsm: |
||||
# We only do this because there's no @action(<name>) yet that we could |
||||
# access from the reactive file. |
||||
hsm = reactive.RelationBase.from_state('hsm.available') |
||||
if hsm is None: |
||||
hookenv.action_fail( |
||||
"Can't generate an MKEK in associated HSM because HSM is not " |
||||
"available.") |
||||
return |
||||
barbican.generate_mkek(hsm) |
||||
|
||||
|
||||
def generate_hmac_action(*args): |
||||
"""Generate an HMAC in the backend HSM""" |
||||
# try and get the reactive relation instance for hsm: |
||||
# We only do this because there's no @action(<name>) yet that we could |
||||
# access from the reactive file. |
||||
hsm = reactive.RelationBase.from_state('hsm.available') |
||||
if hsm is None: |
||||
hookenv.action_fail( |
||||
"Can't generate an HMAC in associated HSM because HSM is not " |
||||
"available.") |
||||
barbican.generate_hmac(hsm) |
||||
|
||||
|
||||
# Actions to function mapping, to allow for illegal python action names that |
||||
# can map to a python function. |
||||
ACTIONS = { |
||||
"generate-mkek": generate_mkek_action, |
||||
"generate-hmac": generate_hmac_action, |
||||
} |
||||
|
||||
|
||||
def main(args): |
||||
action_name = os.path.basename(args[0]) |
||||
try: |
||||
action = ACTIONS[action_name] |
||||
except KeyError: |
||||
return "Action %s undefined" % action_name |
||||
else: |
||||
try: |
||||
action(args) |
||||
except Exception as e: |
||||
hookenv.action_fail(str(e)) |
||||
|
||||
|
||||
if __name__ == "__main__": |
||||
sys.exit(main(sys.argv)) |
||||
@ -1 +1,7 @@
|
||||
includes: ['layer:openstack', 'interface:mysql-shared', 'interface:rabbitmq', 'interface:keystone'] |
||||
includes: |
||||
- layer:openstack |
||||
- interface:mysql-shared |
||||
- interface:rabbitmq |
||||
- interface:keystone |
||||
- interface:barbican-hsm-plugin |
||||
repo: git@github.com:openstack-charmers/charm-barbican.git |
||||
|
||||
@ -0,0 +1,13 @@
|
||||
# Copyright 2016 Canonical Ltd |
||||
# |
||||
# 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. |
||||
@ -0,0 +1,13 @@
|
||||
# Copyright 2016 Canonical Ltd |
||||
# |
||||
# 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. |
||||
@ -0,0 +1,13 @@
|
||||
# Copyright 2016 Canonical Ltd |
||||
# |
||||
# 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. |
||||
@ -0,0 +1,13 @@
|
||||
# Copyright 2016 Canonical Ltd |
||||
# |
||||
# 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. |
||||
@ -1,8 +0,0 @@
|
||||
[pipeline:main] |
||||
pipeline = unauthenticated-context admin |
||||
|
||||
[app:admin] |
||||
paste.app_factory = barbican.api.app:create_admin_app |
||||
|
||||
[filter:unauthenticated-context] |
||||
paste.filter_factory = barbican.api.middleware.context:UnauthenticatedContextMiddleware.factory |
||||