{"id":19963767,"url":"https://github.com/cyberark/summon-keyring","last_synced_at":"2025-06-26T08:34:22.200Z","repository":{"id":34164599,"uuid":"38008676","full_name":"cyberark/summon-keyring","owner":"cyberark","description":"Cross-platform provider for Summon that talks to keyrings.","archived":false,"fork":false,"pushed_at":"2023-10-17T17:40:47.000Z","size":26,"stargazers_count":15,"open_issues_count":4,"forks_count":4,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-05-03T22:37:57.805Z","etag":null,"topics":["conjbot-notify","conjur","conjur-community-team","summon","summon-provider"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyberark.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-06-24T20:16:21.000Z","updated_at":"2023-08-08T01:06:29.000Z","dependencies_parsed_at":"2022-07-11T09:17:27.015Z","dependency_job_id":"5e4d57a3-66b7-4ceb-8f2b-e9381797084b","html_url":"https://github.com/cyberark/summon-keyring","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/cyberark/summon-keyring","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-keyring","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-keyring/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-keyring/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-keyring/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyberark","download_url":"https://codeload.github.com/cyberark/summon-keyring/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-keyring/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262030537,"owners_count":23247673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conjbot-notify","conjur","conjur-community-team","summon","summon-provider"],"created_at":"2024-11-13T02:17:22.600Z","updated_at":"2025-06-26T08:34:22.178Z","avatar_url":"https://github.com/cyberark.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# summon-keyring\n\nCross-platform provider for [Summon](https://github.com/cyberark/summon) that talks to keyrings.\n\nWraps the Python [keyring library](https://pypi.python.org/pypi/keyring) to allow summon to fetch credentials from:\n\n* OSX Keychain\n* Linux Secret Service\n* Windows Credential Vault\n* gnome-keyring\n* kwallet\n\n## Requirements\n\nTo use this provider, you will need to install:\n- [Summon](https://cyberark.github.io/summon/)\n- Python and `pip`\n- The Python [keyring](https://pypi.python.org/pypi/keyring) library.\n  - Note: v21+ of this library requires Python 3.6+.\n\nTo install the Python `keyring` library, run:\n```sh-session\n$ pip install keyring\n```\n\n## Installation\n\nInstall the keyring provider by  cloning the repo and creating a symlink in the\n`/usr/local/lib/summon` directory.\n\nYou may need to run the following commands as a super user.\n\n```\n$ git clone git@github.com:cyberark/summon-keyring.git\n$ cd summon-keyring\n$ mkdir -p /usr/local/lib/summon\n$ ln -s \"$PWD/ring.py\" /usr/local/lib/summon/keyring.py\n```\n\n**Note**: If you copy the `ring.py` file to `/usr/local/lib/summon/` instead\nof symbolically linking it, you may see an error like:\n```\nTraceback (most recent call last):\n  File \"/usr/local/lib/summon/ring.py\", line 22, in \u003cmodule\u003e\n    value = keyring.get_password(\nAttributeError: module 'keyring' has no attribute 'get_password'\n```\nThis can be resolved by creating a symbolic link instead.\n\n## Usage instructions\n\nTo use this provider, invoke Summon as usual. If you have multiple providers\ninstalled, be sure to provide the path to the keyring provider using the\n`--provider` flag:\n```\nsummon --provider keyring.py \\\n  --yaml 'MY_ENV_VAR: !var secret/path' \\\n  my_command\n```\n\nBy default, this provider fetches secrets from the service `summon`. To\nretrieve secrets from another service, set the `SUMMON_KEYRING_SERVICE`\nenvironment variable.\n\n### Example\n\nLet's use the OSX keychain to store a secret and fetch it with summon.\n\nFirst, we add the secret:\n\n```\n$ security add-generic-password -s \"summon\" -a \"secret/path\" -w \"secretvalue\"\n```\n\n**Note**: You can also add a secret to the OSX keychain through the Keychain\nAccess utility.  The \"Keychain Item Name\" field should be `summon`, the\n\"Account Name\" should be the secret path, and the \"Password\" field should\ncontain the secret value. If you are using other secret stores, you can also\nuse the `keyring` command utility installed with the `keyring` Python package\nto set the secret:\n```\n$ keyring set summon secret/path # enter \"secretvalue\" when prompted\n```\n\nOnce the secret has been added, we can fetch it with summon by using this provider.\n\n```sh-session\n$ summon --provider keyring.py \\\n  --yaml 'MYSECRET: !var secret/path' \\\n  printenv MYSECRET\n\nsecretvalue\n```\n\nUsing summon, you can easily switch between this keyring provider for development and use and more appropriate provider, like [Conjur](http://conjur.net/), in production.\n\n## Contributing\n\nWe welcome contributions of all kinds to this repository. For instructions on how to get started and descriptions\nof our development workflows, please see our [contributing guide](CONTRIBUTING.md).\n\n## License\n\nCopyright (c) 2020 CyberArk Software Ltd. All rights reserved.\n\nLicensed under the MIT License (MIT).\n\nFor the full license text see [`LICENSE`](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberark%2Fsummon-keyring","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyberark%2Fsummon-keyring","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberark%2Fsummon-keyring/lists"}