{"id":19963681,"url":"https://github.com/cyberark/summon-conjur","last_synced_at":"2025-05-09T00:07:42.846Z","repository":{"id":32380119,"uuid":"35956445","full_name":"cyberark/summon-conjur","owner":"cyberark","description":"CyberArk Conjur provider for Summon","archived":false,"fork":false,"pushed_at":"2024-07-25T21:13:48.000Z","size":445,"stargazers_count":39,"open_issues_count":2,"forks_count":9,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-05-09T00:07:34.942Z","etag":null,"topics":["conjbot-notify","conjur","conjur-community-team","machine-identity","secret-distribution","summon","summon-provider"],"latest_commit_sha":null,"homepage":"","language":"Go","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}},"created_at":"2015-05-20T15:23:53.000Z","updated_at":"2025-04-08T09:19:11.000Z","dependencies_parsed_at":"2023-10-15T03:41:25.464Z","dependency_job_id":"76041f34-f068-4759-ab87-821d93578411","html_url":"https://github.com/cyberark/summon-conjur","commit_stats":null,"previous_names":["conjurinc/cauldron-conjur"],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-conjur","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-conjur/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-conjur/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberark%2Fsummon-conjur/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyberark","download_url":"https://codeload.github.com/cyberark/summon-conjur/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253166520,"owners_count":21864482,"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","machine-identity","secret-distribution","summon","summon-provider"],"created_at":"2024-11-13T02:16:48.469Z","updated_at":"2025-05-09T00:07:42.814Z","avatar_url":"https://github.com/cyberark.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# summon-conjur\n\nConjur provider for [Summon](https://github.com/cyberark/summon).\n\n[![GitHub release](https://img.shields.io/github/release/cyberark/summon-conjur.svg)](https://github.com/cyberark/summon-conjur/releases/latest)\n\n[![Github commits (since latest release)](https://img.shields.io/github/commits-since/cyberark/summon-conjur/latest.svg)](https://github.com/cyberark/summon-conjur/commits/main)\n\n---\n\n## Install\n\nPre-built binaries and packages are available from GitHub releases\n[here](https://github.com/cyberark/summon-conjur/releases).\n\n### Using summon-conjur with Conjur Open Source\n\nAre you using this project with [Conjur Open Source](https://github.com/cyberark/conjur)? Then we\n**strongly** recommend choosing the version of this project to use from the latest [Conjur OSS\nsuite release](https://docs.conjur.org/Latest/en/Content/Overview/Conjur-OSS-Suite-Overview.html).\nConjur maintainers perform additional testing on the suite release versions to ensure\ncompatibility. When possible, upgrade your Conjur version to match the\n[latest suite release](https://docs.conjur.org/Latest/en/Content/ReleaseNotes/ConjurOSS-suite-RN.htm);\nwhen using integrations, choose the latest suite release that matches your Conjur version. For any\nquestions, please contact us on [Discourse](https://discuss.cyberarkcommons.org/c/conjur/5).\n\n### Homebrew\n\n```bash\nbrew tap cyberark/tools\nbrew install summon-conjur\n```\n\n### Linux (Debian and Red Hat flavors)\n\n`deb` and `rpm` files are attached to new releases.\nThese can be installed with `dpkg -i summon-conjur_*.deb` and\n`rpm -ivh summon-conjur_*.rpm`, respectively.\n\n### Auto Install\n\n**Note** Check the release notes and select an appropriate release to ensure support for your version of Conjur.\n\nUse the auto-install script. This will install the latest version of summon-conjur.\nThe script requires sudo to place summon-conjur in dir `/usr/local/lib/summon`.\n\n```bash\ncurl -sSL https://raw.githubusercontent.com/cyberark/summon-conjur/main/install.sh | bash\n```\n\n### Manual Install\n\nOtherwise, download the [latest release](https://github.com/cyberark/summon-conjur/releases) and extract it to the directory `/usr/local/lib/summon`.\n\n## Usage in isolation\n\nGive summon-conjur a variable name and it will fetch it for you and print the value to stdout.\n\n```shell\n$ summon-conjur prod/aws/iam/user/robot/access_key_id\nflgwkeatfghhdqkflaqiwoagsmfgxool\n```\n\nYou can also use interactive mode by starting the command without any arguments \nand then passing paths to secrets one by one. This way you can fetch multiple values in a single command run.\nKeep in mind that by using interactive mode outputted values will be in BASE64 format.\n\n```shell\n$ summon-conjur\nprod/aws/iam/user/robot/access_key_id\nZmxnd2tlYXRmZ2hoZHFrZmxhcWl3b2Fnc21mZ3hvb2w=\nprod/aws/s3/bucket_name/access_key_id\nYWNudmdlb3dycmd4dW1ic2tncW51Zm50dmRvYWVic3A=\n```\n\n### Flags\n\n```txt\nUsage of summon-conjur:\n  -h, --help\n show help (default: false)\n  -V, --version\n show version (default: false)\n  -v, --verbose\n be verbose (default: false)\n```\n\n## Usage as a provider for Summon\n\n[Summon](https://github.com/cyberark/summon/) is a command-line tool that reads a file in secrets.yml format and injects secrets as environment variables into any process. Once the process exits, the secrets are gone.\n\n### Example\n\nAs an example let's use the `env` command:\n\nFollowing installation, define your keys in a `secrets.yml` file\n\n```yml\nAWS_ACCESS_KEY_ID: !var aws/iam/user/robot/access_key_id\nAWS_SECRET_ACCESS_KEY: !var aws/iam/user/robot/secret_access_key\n```\n\nBy default, summon will look for `secrets.yml` in the directory it is called from and export the secret values to the environment of the command it wraps.\n\nWrap the `env` in summon:\n\n```sh\n$ summon --provider summon-conjur env\n...\nAWS_ACCESS_KEY_ID=AKIAJS34242K1123J3K43\nAWS_SECRET_ACCESS_KEY=A23MSKSKSJASHDIWM\n...\n```\n\n`summon` resolves the entries in secrets.yml with the conjur provider and makes the secret values available to the environment of the command `env`.\n\n## Configuration\n\nThis provider uses the same configuration pattern as the [Conjur CLI](https://github.com/cyberark/conjur-cli-go)\nto connect to Conjur. Specifically, it loads configuration from:\n\n* `.conjurrc` files, located in the home and current directories, or at the\n    path specified by the `CONJURRC` environment variable.\n* Reads the `.conjurrc` file from `/etc/conjur.conf` on Linux/macOS and `C:\\Windows\\conjur.conf` on Windows.\n* Environment variables:\n  * Appliance URLs\n    * `CONJUR_APPLIANCE_URL`\n  * SSL certificate\n    * `CONJUR_CERT_FILE`\n    * `CONJUR_SSL_CERTIFICATE`\n  * Authentication\n    * Account\n      * `CONJUR_ACCOUNT`\n    * Login\n      * `CONJUR_AUTHN_LOGIN`\n      * `CONJUR_AUTHN_API_KEY`\n    * Token\n      * `CONJUR_AUTHN_TOKEN`\n      * `CONJUR_AUTHN_TOKEN_FILE`\n    * JWT Token\n      * `CONJUR_AUTHN_JWT_SERVICE_ID`  (e.g. `kubernetes`)\n      * `JWT_TOKEN_PATH` (optional)  (default: `/var/run/secrets/kubernetes.io/serviceaccount/token`)\n\nIf `CONJUR_AUTHN_LOGIN` and `CONJUR_AUTHN_API_KEY` or `CONJUR_AUTHN_TOKEN` or `CONJUR_AUTHN_TOKEN_FILE` or `CONJUR_AUTHN_JWT_SERVICE_ID` are not provided, the username and API key are read from system keychain or `~/.netrc`, stored there by `conjur login`.\n\nOn systems that support keychain storage, that will be used by default, and if that fails the `~/.netrc` file will be used,\nthough this behavior can be modified in the `.conjurrc` file:\n\n```yaml\n...\ncredential_storage: \"netrc\"\nnetrc_path: \"/etc/conjur.identity\"\n...\n```\n\nThe provider will fail unless all of the following values are provided:\n\n* An appliance url (`CONJUR_APPLIANCE_URL`)\n* An organization account (`CONJUR_ACCOUNT`)\n* A username and api key, or Conjur authn token, or a path to `CONJUR_AUTHN_TOKEN_FILE` a dynamic Conjur authn token\n* A path to (`CONJUR_CERT_FILE`) **or** content of (`CONJUR_SSL_CERTIFICATE`) the appliance's public SSL certificate\n\n---\n\n## Contributing\n\nWe welcome contributions of all kinds to this repository. For instructions on how to get started and descriptions of our development workflows, please see our [contributing\nguide][contrib].\n\n[contrib]: CONTRIBUTING.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberark%2Fsummon-conjur","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyberark%2Fsummon-conjur","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberark%2Fsummon-conjur/lists"}