-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathparams.json
More file actions
1 lines (1 loc) · 1.44 KB
/
params.json
File metadata and controls
1 lines (1 loc) · 1.44 KB
1
{"name":"Openpassword","tagline":"","body":"### What's OpenPassword?\r\n\r\nOpenpassword is a python API to access an Agilekeychain.\r\n\r\n### Can I see some API examples?\r\n\r\nCurrently OpenPassword is in early development stage, and most of the API is yet to implement. Here are some examples of the few implemented bits:\r\n\r\n#### Unlocking the keychain\r\n\r\n```python\r\nfrom openpassword import Keychain\r\nfrom openpassword import EncryptionKeyFactory\r\n\r\nkeychain = Keychain(EncryptionKeyFactory(keys).key_for_security_level(\"SL5\"))\r\nkeychain.unlock()\r\n\r\n```\r\n\r\n#### Decrypting an encryption key\r\n\r\n```python\r\nfrom openpassword import EncryptionKey\r\n\r\nencryption_key = EncryptionKeyFactory(keys).key_for_security_level(\"SL5\")\r\ndecrypted_key = encryption_key.decrypt('masterpassword123')\r\n```\r\n\r\nThe `keys` parameter passed to the EncryptionKeyFactory is a dictionary similar to the one found in the [EncryptionKeyFactorySpec](https://github.com/OpenPassword/OpenPassword/blob/develop/spec/openpassword/encryption_key_factory_spec.py#L7) file.\r\n\r\n### Contributing\r\n\r\nFirst check the \"[How to contribute](/OpenPassword/OpenPassword/blob/develop/CONTRIBUTING.md#contributing)\" page.\r\n\r\nThen, [fork the repository](https://github.com/OpenPassword/OpenPassword/fork), create your feature and make a pull request.","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}