Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/okigan/awscurl

curl-like access to AWS resources with AWS Signature Version 4 request signing.
https://github.com/okigan/awscurl

aws aws-signature curl

Last synced: 27 days ago
JSON representation

curl-like access to AWS resources with AWS Signature Version 4 request signing.

Host: GitHub
URL: https://github.com/okigan/awscurl
Owner: okigan
License: mit
Created: 2015-10-21T20:22:38.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-08-26T04:57:20.000Z (3 months ago)
Last Synced: 2024-10-12T21:55:02.210Z (28 days ago)
Topics: aws, aws-signature, curl
Language: Python
Homepage:
Size: 312 KB
Stars: 755
Watchers: 9
Forks: 94
Open Issues: 32
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # awscurl [![Donate](https://img.shields.io/badge/donate-github-orange.svg?style=flat-square)](https://github.com/sponsors/okigan) [![Donate](https://img.shields.io/badge/donate-paypal-orange.svg?style=flat-square)](https://www.paypal.com/donate/?business=UDN4FL55J34QC&amount=25) [![Donate](https://img.shields.io/badge/donate-buy_me_a_coffee-orange.svg?style=flat-square)](https://www.buymeacoffee.com/okigan)

[![PyPI](https://img.shields.io/pypi/v/awscurl.svg)](https://pypi.python.org/pypi/awscurl)

[![Build Status](https://github.com/okigan/awscurl/actions/workflows/pythonapp.yml/badge.svg)](https://github.com/okigan/awscurl)

[![Docker Hub](https://img.shields.io/docker/pulls/okigan/awscurl.svg)](https://hub.docker.com/r/okigan/awscurl)

![CI badge](https://github.com/okigan/awscurl/workflows/CI/badge.svg?branch=master)

[![Edit with gitpod](https://img.shields.io/badge/edit--with-gitpod-blue.svg?style=flat-square)](https://gitpod.io/#https://github.com/okigan/awscurl)

[![Edit with vscode](https://img.shields.io/badge/edit--with-vscode-blue.svg?style=flat-square)](https://vscode.dev/github/okigan/awscurl)

[![Edit with github codespaces](https://img.shields.io/badge/edit--with-codespaces-blue.svg?style=flat-square)](https://github.dev/okigan/awscurl)

curl-like tool with AWS Signature Version 4 request signing.

## Features

* performs requests to AWS services with request signing using curl interface

* supports IAM profile credentials

## Overview

Requests to AWS API must be signed (see [Signing AWS API Requests](http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html))

automates the process of signing and makes requests to AWS as simple as a standard curl command.

## Installation

```sh

pip install awscurl

```

  

### Installation from source (bleeding edge)

```sh

pip install git+https://github.com/okigan/awscurl

```

### Installation via Homebrew for MacOS

```sh

brew install awscurl

```

#### Running via Docker

```sh

docker pull okigan/awscurl # or via docker pull ghcr.io/okigan/awscurl 

```

  or via Github docker registry

```sh

docker pull ghcr.io/okigan/awscurl 

```

  then

  ```sh

  $ docker run --rm -it okigan/awscurl --access_key ACCESS_KEY  --secret_key SECRET_KEY --service s3 s3://...

  # or allow access to local credentials as following

  $ docker run --rm -it -v "$HOME/.aws:/root/.aws" okigan/awscurl --service s3 s3://...

  ```

  To shorten the length of docker commands use the following alias:

  ```sh

  alias awscurl='docker run --rm -ti -v "$HOME/.aws:/root/.aws" -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e AWS_SECURITY_TOKEN -e AWS_PROFILE okigan/awscurl'

  ```

  This will allow you to run awscurl from within a Docker container as if it was installed on the host system:

  ```sh

  awscurl

  ```

## Examples

* Call S3: List bucket content

  ```sh

  $ awscurl --service s3 'https://awscurl-sample-bucket.s3.amazonaws.com' | tidy -xml -iq

  

  

    awscurl-sample-bucket

    

    

    1000

    false

    

      awscurl-sample-file.txt

      2017-07-25T21:27:38.000Z

      "d41d8cd98f00b204e9800998ecf8427e"

      0

      STANDARD

    

  

  ```

* Call EC2:

  ```sh

  $ awscurl --service ec2 'https://ec2.amazonaws.com?Action=DescribeRegions&Version=2013-10-15' | tidy -xml -iq 

  

  

    96511ccd-2d6d-4d63-ad9b-6be6f2c9874d

    

      

        eu-north-1

        ec2.eu-north-1.amazonaws.com

      

      

        ap-south-1

        ec2.ap-south-1.amazonaws.com

      

    

  

  ```

* Call API Gateway:

  ```sh

  $ awscurl --service execute-api -X POST -d @request.json \

    https://.execute-api.us-east-1.amazonaws.com/

  ```

## Options

```sh

usage: __main__.py [-h] [-v] [-i] [-X REQUEST] [-d DATA] [-H HEADER] [-k] [--fail-with-body] [--data-binary] [--region REGION] [--profile PROFILE] [--service SERVICE]

                   [--access_key ACCESS_KEY] [--secret_key SECRET_KEY] [--security_token SECURITY_TOKEN] [--session_token SESSION_TOKEN] [-L] [-o ]

                   uri

Curl AWS request signing

positional arguments:

  uri

options:

  -h, --help            show this help message and exit

  -v, --verbose         verbose flag (default: False)

  -i, --include         include headers in the output (default: False)

  -X REQUEST, --request REQUEST

                        Specify request command to use (default: GET)

  -d DATA, --data DATA  HTTP POST data (default: )

  -H HEADER, --header HEADER

                        HTTP header (default: None)

  -k, --insecure        Allow insecure server connections when using SSL (default: False)

  --fail-with-body      Fail on HTTP errors but save the body (default: False)

  --data-binary         Process HTTP POST data exactly as specified with no extra processing whatsoever. (default: False)

  --region REGION       AWS region [env var: AWS_DEFAULT_REGION] (default: us-east-1)

  --profile PROFILE     AWS profile [env var: AWS_PROFILE] (default: default)

  --service SERVICE     AWS service (default: execute-api)

  --access_key ACCESS_KEY

                        [env var: AWS_ACCESS_KEY_ID] (default: None)

  --secret_key SECRET_KEY

                        [env var: AWS_SECRET_ACCESS_KEY] (default: None)

  --security_token SECURITY_TOKEN

                        [env var: AWS_SECURITY_TOKEN] (default: None)

  --session_token SESSION_TOKEN

                        [env var: AWS_SESSION_TOKEN] (default: None)

  -L, --location        Follow redirects (default: False)

  -o , --output 

                        Write to file instead of stdout (default: )

 In general, command-line values override environment variables which override defaults.

```

If you do not specify the `--access_key` or `--secret_key`

(or environment variables), `awscurl` will attempt to use

the credentials you set in `~/.aws/credentials`. If you

do not specify a `--profile` or `AWS_PROFILE`, `awscurl`

uses `default`.

## Who uses awscurl

* [AWS Documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)

* [Onica blog](https://onica.com/blog/how-to/how-to-kibana-default-index-pattern/)

* QnA on [StackOverflow](https://stackoverflow.com/search?q=awscurl)

* QnA on [DevOps StackExchange](https://devops.stackexchange.com/search?q=awscurl)

* Examples on [Golfbert](https://golfbert.com/api/samples)

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=okigan/awscurl)](https://star-history.com/#okigan/awscurl&Date)

## Related projects

* awscurl in Go:

  * 

  * 

* awscurl in Lisp: 

* awscurl on DockerHub: 

* [aws-signature-proxy](https://github.com/sverch/aws-signature-proxy) and related [blog post](https://shaunverch.com/butter/open-source/2019/09/27/butter-days-6.html)

* [aws-sigv4-proxy](https://github.com/awslabs/aws-sigv4-proxy) on awslabs

## Last but not least

* [Sponsor awscurl](https://github.com/sponsors/okigan)