{"id":23131223,"url":"https://github.com/emartech/insomnia-plugin-escher-auth","last_synced_at":"2025-04-04T07:27:47.498Z","repository":{"id":57748927,"uuid":"524014810","full_name":"emartech/insomnia-plugin-escher-auth","owner":"emartech","description":"Escher authentication plugin for Insomnia","archived":false,"fork":false,"pushed_at":"2023-07-31T10:23:08.000Z","size":133,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-04-14T07:41:02.532Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/emartech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSES/MIT.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-12T08:39:53.000Z","updated_at":"2022-08-15T09:20:02.000Z","dependencies_parsed_at":"2024-12-17T11:12:26.124Z","dependency_job_id":"e5b70ee3-038b-434f-96e8-bacebb286612","html_url":"https://github.com/emartech/insomnia-plugin-escher-auth","commit_stats":{"total_commits":9,"total_committers":1,"mean_commits":9.0,"dds":0.0,"last_synced_commit":"2e611760e59a696a89d0902a112adad4dfe7fe0e"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emartech%2Finsomnia-plugin-escher-auth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emartech%2Finsomnia-plugin-escher-auth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emartech%2Finsomnia-plugin-escher-auth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emartech%2Finsomnia-plugin-escher-auth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emartech","download_url":"https://codeload.github.com/emartech/insomnia-plugin-escher-auth/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247137691,"owners_count":20889913,"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":[],"created_at":"2024-12-17T11:12:21.246Z","updated_at":"2025-04-04T07:27:47.467Z","avatar_url":"https://github.com/emartech.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: 2022 SAP Emarsys\n\nSPDX-License-Identifier: MIT\n--\u003e\n\n# Escher authentication plugin for Insomnia\n\n## Description\nAn Insomnia plugin to sign the requests with [Escher](http://escherauth.io/) authentication.\n\n## Requirements\n- [Insomnia](https://insomnia.rest/)\n\n## Contributing\nThis package is only maintained by SAP Emarsys employees\n\n## Code of Conduct\nYou can find the Code of Conduct document [here](./CODE_OF_CONDUCT.md).\n\n## Licensing\nYou can find the License document [here](./LICENSES/MIT.txt).\nYou can check the licencing with the [Reuse Tool](https://reuse.software/).\n\n## Installation\n1. Open Insomnia application\n2. Go to Application \u003e Preferences \u003e Plugins \n3. Enter insomnia-plugin-escher-auth \n4. Click \"Install Plugin\"\n\n## Upgrade to newer plugin version\n1. Open Insomnia application\n2. Go to Application \u003e Preferences \u003e Plugins\n3. Enter insomnia-plugin-escher-auth\n4. Click \"Install Plugin\"\n5. Click \"Reload Plugins\"\n\n## Configuration\nTo use this plugin you need to configure the Escher keypool as environment variable\n1. Open the `Manage Environments` dialog (CMD + E)\n2. Create a new environment with the `+` icon and name it like `with escher`\n3. Set the keypool like this\n```json\n{\n  \"escherKeypool\": [\n      {\n        \"host\": \"your-host.com\",\n        \"credentialScope\": \"eu/your-service/ems_request\",\n        \"key\": \"some-key\",\n        \"secret\": \"some-secret\",\n        \"algoPrefix\": \"some-algo-prefix\",\n        \"vendorKey\": \"some-vendor-key\",\n        \"authHeaderName\": \"X-Some-Authorization\",\n        \"dateHeaderName\": \"X-Some-Date\"\n      },\n      {\n        \"host\": \"your-other-host.com\",\n        \"credentialScope\": \"eu/your-other-service/ems_request\",\n        \"key\": \"other-key\",\n        \"secret\": \"other-secret\",\n        \"algoPrefix\": \"other-algo-prefix\",\n        \"vendorKey\": \"other-vendor-key\",\n        \"authHeaderName\": \"X-Other-Authorization\",\n        \"dateHeaderName\": \"X-Other-Date\"\n      }\n  ]\n}\n```\n4. Create another environment with the `+` icon and name it like `without escher` and keep it empty\n\n## Usage\n- First you need to configure your Escher keypool by following the above steps\n- In the environment selector choose the `with escher` environment\n- Then you'll be able to send requests to the configured hosts (presents in the keypool) and the plugin will add the Escher signed headers to the request automatically\n- If you want to send request without escher authentication simply change the environment to the `witout escher` one\n\n__Important__: The plugin finds the right escher key fom keypool based on the request's host, so you need to setup the keypool properly\n\n## Debugging\n- To open the debugger press CMD+ALT+I\n- There will be a message on the console when the plugin can't find the key in the keypool for the requested host\n`Escher key was not found in the keypool for your-host.com`\n\n## Known issues\nIf you have `.npmrc` file in your home folder it can cause error during the plugin installation `An unexpected error occurred: \"Failed to replace env in config: ${NPM_TOKEN}\"`\nIn this case just delete your `.npmrc` file to fix the installation process\n\n## How to obtain support\nIf you found a bug or experienced strange behaviour, feel free to open an issue on the project's [GitHub Issues page](https://github.com/emartech/insomnia-plugin-escher-auth/issues).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femartech%2Finsomnia-plugin-escher-auth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femartech%2Finsomnia-plugin-escher-auth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femartech%2Finsomnia-plugin-escher-auth/lists"}