PyKMIP

A Python implementation of the KMIP specification.

Go to file

Peter Hamilton 8260da0905 Merge pull request #418 from OpenKMIP/bug/derive-key-usage-masks Add cryptographic usage mask support for DeriveKey		2018-04-11 22:16:14 -04:00
.travis	Update the Travis CI config to add policies for integration tests	2018-02-20 13:03:55 -05:00
bin	Add a certificate creation script	2018-04-02 10:13:29 -04:00
docs	Fix help text for the CreateKeyPair demo	2018-03-07 21:31:51 +01:00
examples	Update operation policy file examples	2018-02-19 12:25:21 -05:00
kmip	Add cryptographic usage mask support for DeriveKey	2018-04-11 20:44:20 -04:00
.gitignore	Update and clean up .gitignore	2018-02-14 15:55:27 -05:00
.travis.yml	Update the Travis CI infrastructure to run integration tests	2017-12-07 16:03:22 -05:00
CHANGELOG.rst	Add Sphinx documentation	2017-11-17 13:50:52 -05:00
LICENSE.txt	Update the project license, removing an unneeded appendix	2018-02-12 13:49:11 -05:00
MANIFEST.in	Adding server key and cert files to installation	2014-12-10 18:43:56 -05:00
README.rst	Update README to align with new project documentation	2017-12-07 10:52:38 -05:00
pytest.ini	Updating integration tests to ignore software server	2015-08-20 09:13:20 -04:00
requirements.txt	Add an authentication plugin framework	2018-03-06 22:53:29 -05:00
setup.py	Drop Python 3.3 support	2017-12-07 14:53:53 -05:00
test-requirements.txt	Drop Python 3.3 support	2017-12-07 14:53:53 -05:00
tox.ini	Drop Python 3.3 support	2017-12-07 14:53:53 -05:00

README.rst

------
PyKMIP
------
|pypi-version|
|travis-status|
|codecov-status|
|python-versions|

PyKMIP is a Python implementation of the Key Management Interoperability
Protocol (KMIP), an `OASIS`_ communication standard for the management of
objects stored and maintained by key management systems. KMIP defines how key
management operations and operation data should be encoded and communicated
between client and server applications. Supported operations include the full
`CRUD`_ key management lifecycle, including operations for managing object
metadata and for conducting cryptographic operations. Supported object types
include:

* symmetric/asymmetric encryption keys
* passwords/passphrases
* certificates
* opaque data blobs, and more

For more information on KMIP, check out the `OASIS KMIP Technical Committee`_
and the `OASIS KMIP Documentation`_.

For more information on PyKMIP, check out the project `Documentation`_.

Installation
------------
You can install PyKMIP via ``pip``:

.. code-block:: console

    $ pip install pykmip

See `Installation`_ for more information.

Community
---------
The PyKMIP community has various forums and resources you can use:

* `Source code`_
* `Issue tracker`_
* IRC: ``#pykmip`` on ``irc.freenode.net``
* Twitter: ``@pykmip``


.. _`CRUD`: https://en.wikipedia.org/wiki/Create,_read,_update_and_delete
.. _`OASIS`: https://www.oasis-open.org
.. _`OASIS KMIP Technical Committee`: https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=kmip
.. _`OASIS KMIP Documentation`: https://docs.oasis-open.org/kmip/spec/
.. _`Documentation`: https://pykmip.readthedocs.io/en/latest/index.html
.. _`Installation`: https://pykmip.readthedocs.io/en/latest/installation.html
.. _`Source code`: https://github.com/openkmip/pykmip
.. _`Issue tracker`: https://github.com/openkmip/pykmip/issues

.. |pypi-version| image:: https://img.shields.io/pypi/v/pykmip.svg
  :target: https://pypi.python.org/pypi/pykmip
  :alt: Latest Version
.. |travis-status| image:: https://travis-ci.org/OpenKMIP/PyKMIP.svg?branch=master
  :target: https://travis-ci.org/OpenKMIP/PyKMIP
.. |codecov-status| image:: https://codecov.io/github/OpenKMIP/PyKMIP/coverage.svg?branch=master
  :target: https://codecov.io/github/OpenKMIP/PyKMIP?branch=master
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/PyKMIP.svg
  :target: https://github.com/OpenKMIP/PyKMIP