{"id":17109567,"url":"https://github.com/monken/aws4-proxy","last_synced_at":"2025-04-13T03:21:51.275Z","repository":{"id":46062395,"uuid":"245200073","full_name":"monken/aws4-proxy","owner":"monken","description":"Fast, low-footprint aws4 signing proxy with WebSocket support","archived":false,"fork":false,"pushed_at":"2021-11-16T22:09:35.000Z","size":47,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T20:21:26.038Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/monken.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"monken"}},"created_at":"2020-03-05T15:31:24.000Z","updated_at":"2024-06-01T07:54:55.000Z","dependencies_parsed_at":"2022-09-17T23:00:48.719Z","dependency_job_id":null,"html_url":"https://github.com/monken/aws4-proxy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monken%2Faws4-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monken%2Faws4-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monken%2Faws4-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/monken%2Faws4-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/monken","download_url":"https://codeload.github.com/monken/aws4-proxy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248658377,"owners_count":21140932,"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-10-14T16:23:37.810Z","updated_at":"2025-04-13T03:21:51.249Z","avatar_url":"https://github.com/monken.png","language":"TypeScript","funding_links":["https://github.com/sponsors/monken"],"categories":[],"sub_categories":[],"readme":"[![npm](http://img.shields.io/npm/v/aws4-proxy.svg?style=flat-square)](https://npmjs.org/package/aws4-proxy)\n![GitHub Workflow Status](https://img.shields.io/github/workflow/status/monken/aws4-proxy/build?style=flat-square)\n![Apache License](https://img.shields.io/badge/license-Apache--2.0-yellow?style=flat-square)\n![Dependencies](https://img.shields.io/badge/dependencies-2-blue?style=flat-square)\n\n# aws4-proxy\n\n**Fast, low-footprint aws4 signing proxy with WebSocket support**\n\n```bash\n# Create a signing proxy to S3 and then use the CLI to access without signing\naws4-proxy --service s3 --region us-east-1\naws s3 ls --endpoint http://localhost:3000 --no-sign-request\n\n# Proxy to an API Gateway with AWS_IAM authentication and query using curl\naws4-proxy --service execute-api --region eu-west-1 --endpoint api.mycorp.com\ncurl http://localhost:3000/v1/my-api/\n\n# Proxy to an Elasticsearch instance with IAM authentication and open Kibana\naws4-proxy --service es --region us-east-2 --endpoint search-nfvgk3cqs3nk3u.us-east-2.es.amazonaws.com\nopen http://localhost:3000/_plugin/kibana/\n\n# Proxy to a Neptune DB that sits behind a Network Load Balancer with a custom domain name\naws4-proxy --service neptune-db --endpoint neptune.mycorp.com --endpoint-host cluster-die4eenu.cluster-eede5pho.eu-west-1.neptune.amazonaws.com --region eu-west-1\nwscat localhost:3000/gremlin\n```\n\n**Command line options:**\n\nOptions:\n*  `--help` Show help                                           [boolean]\n*  `--service` **string** [required]\n*  `--region` **string** [required] [default: \"AWS_DEFAULT_REGION\"]\n*  `--version` Show version number **boolean**\n*  `--level` [default: \"info\"]\n*  `--host`, `-h` [default: \"127.0.0.1\"]\n*  `--port`, `-p` **number** [default: 3000]\n*  `--endpoint` **string**\n\n    Required for services that provide a unique endpoint per resource such as the API Gateway, Neptune, Elasticsearch Service, etc.\n*  `--endpoint-host` **string**\n\n    If the endpoint is accessed via a custom hostname (e.g. using a CNAME record or a custom load balancer) provide the original endpoint hostname. Depending on the service, this is required for the signature to be valid.\n\n\n## Installation\n\n```bash\nnpm install --global aws4-proxy\n\n# or without installing\nnpx aws4-proxy --help\n```\n\n## Authentication\n\nThe proxy will check for the availability of the `aws-sdk` package (not installed as part of this package). If available it uses the [`CredentialProviderChain`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CredentialProviderChain.html) class which will automatically locate and load credentials. If the package is not available, credentials are loaded from environment variables only (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and optionally `AWS_SESSION_TOKEN`).\n\n## Features\n\n* Supports WebSocket (e.g. Neptune, API Gateway)\n* No limit on body size\n* Efficient and fast\n* Few external dependencies\n* Supports proxying Kibana for Elasticsearch Service\n* Ability to separately define the hostname used for signing (necessary if your endpoint is behind a custom domain)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonken%2Faws4-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmonken%2Faws4-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmonken%2Faws4-proxy/lists"}