HTTPie Auth Store
HTTPie Auth Store is an HTTPie authentication plugin that automatically selects the appropriate authentication type and payload from a file containing authentication bindings, then uses them for the current request. No more memorizing or searching for tokens, usernames, or passwords — simply add them to the authentication store, and the plugin handles the rest. This plugin also supports various secret storage options, such as system keychains and password managers (see supported Secret providers).
Eager to get started? Just start with installing!
httpie cli plugins install httpie-auth-store
or via pip in the same python environment where HTTPie is installed:
python3 -m pip install httpie-auth-store
Table of Content
Usage
Once installed, the plugin looks for auth_store.json located in the HTTPie
configuration directory. On macOS and Linux, it tries the following locations:
$HTTPIE_CONFIG_DIR/auth_store.json, $HOME/.httpie/auth_store.json and
$XDG_CONFIG_HOME/httpie/auth_store.json; on Windows —
%HTTPIE_CONFIG_DIR%\auth_store.json and %APPDATA%\httpie\auth_store.json
The authentication store is a JSON file that contains two sections: bindings
and secrets:
{
"bindings": [
{
"auth_type": "bearer",
"auth": "$GITHUB_TOKEN",
"resources": ["https://api.github.com/"]
},
{
"id": "bots",
"auth_type": "bearer",
"auth": "ZWFzdGVyIGVnZwo",
"resources": ["https://api.github.com/"]
},
],
"secrets": {
"GITHUB_TOKEN": {
"provider": "system",
"service": "github.com",
"username": "ikalnytskyi"
}
}
}
Each binding is a JSON object that contains the following keys:
-
id(str, optional) is an authentication binding ID that can be used to overcome ambiguity when two or more bindings are matched. -
auth_type(str, required) is an authentication type supported by HTTPie, either natively or via third-party plugins. See Authentication types for details. -
auth(str, optional) is an authentication payload for the given authentication type. Required for certain authentication types, optional for others. Tokens started with$are replaced with secrets referred by those tokens. The$sign must be escaped ($$) to remain untouched. -
resources(List[str], required) is an array of URLs to activate this binding for. Must contain both scheme and hostname.
Each secret is a KV-pair, where key is a secret name, and value is either a
secret itself or a JSON object that specified how a secret must be retrieved
from secure storage. The JSON object must contain the provider key. Presence
of other keys are provider dependent (see Secret providers section below).
Once the authenticate store is set up, just pass -A store to HTTPie to
activate the plugin and perform some magic for you.
http -A store https://api.github.com
If there are two or more authentication bingind in the store that match the
same resource, you can select appropriate binding by providing a binding ID by
passing -a or --auth to HTTPie. This might come handy when you have
multiple accounts on the same web resource.
http -A store -a bots https://api.github.com
Authentication types
HTTPie Auth Store supports both built-in and third-party HTTPie authentication types as well as provides few authentication types on its own.
basic
The 'Basic' HTTP authentication type as defined in RFC 7617. Transmits credentials as username/password pairs, encoded using Base64.
{
"auth_type": "basic",
"auth": "ihor:p@ss"
}
where
authis a:-delimited username/password pair
digest
The 'Digest' HTTP authentication type as defined in RFC 2617. It applies a hash function to the username and password before sending them over the network.
{
"auth_type": "digest",
"auth": "ihor:p@ss"
}
where
authis a:-delimited username/password pair
bearer
The 'Bearer' HTTP authentication type transmits token in the Authorization
HTTP header.
{
"auth_type": "bearer",
"auth": "t0ken"
}
where
authis a bearer token to authenticate with
header
The 'Header' authentication type is not exactly an authentication scheme. It's rather a way to set a free-formed HTTP header that may or may not contain any secret material.
{
"auth_type": "header",
"auth": "X-Secret:s3cret"
}
where
authis a:-delimited HTTP header name/value pair
The 'Header' authentication type can be used to bypass any kind of limitations
imposed by built-in or third-party authentication types. For instance, you can
pass a bearer token with non-default authentication scheme, say JWT, without
breaking a sweat.
{
"auth_type": "header",
"auth": "Authorization:JWT t0ken"
}
composite
The 'Composite' authentication type is a not an authentication type either.
It's a way to use multiple authentication types simultaneously. It might come
handy when in addition to basic or bearer authentication, you have to
supply an extra secret via custom HTTP header.
{
"auth_type": "composite",
"auth": [
{
"auth_type": "bearer",
"auth": "t0ken"
},
{
"auth_type": "header",
"auth": "X-Secret:s3cret"
}
]
}
where
authis a list of authentication entries, as supported by HTTPie
hmac
The 'HMAC' authentication type is not built-in and requires the httpie-hmac
plugin to be installed first. Its only purpose here is to serve as an example
of how to use a third-party authentication type in the authentication store.
{
"auth_type": "hmac",
"auth": "secret:czNjcjN0Cg=="
}
where
authis a HMAC specific authentication payload
Secret providers
The plugin supports some secret providers that can be used to retrieve tokens, passwords and other secret materials from various secured storages.
sh
The 'Sh' secret provider retrieves a secret from the standard output of the shell script. This is a universal approach that can be used to retrieve secrets from unsupported password managers using their command line interfaces.
{
"provider": "sh",
"script": "cat ~/path/to/secret | tr -d '\n'"
}
where
scriptis a shell script to execute
system
The 'System' secret provider, as the name suggests, retrieves a secret from your system keychain. It may be KWallet, GNOME Keyring, macOS Keychain or even Windows Credential Locker.
{
"provider": "system",
"service": "github",
"username": "ikalnytskyi"
}
where
serviceis a service to retrieve a secret fromusernameis a username to retrieve a secret from
password-store
The 'Password Store' secret provider invokes the pass executable on your
system, and retrieves the secret from the first line of referred record.
{
"provider": "password-store",
"name": "github.com/ikalnytskyi"
}
where
nameis a password-store entry name to retrieve a secret from
FAQ
-
Q: How to get know what authentication is used for the given request?
A: You can run HTTPie with
--offlineargument to print the request header along with injected authentication credentials.
Metadata
Release files for httpie-auth-store 4.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| httpie_auth_store-4.0.0.tar.gz | 10.8 kB | Without provenance | Details for httpie_auth_store-4.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| httpie_auth_store-4.0.0-py3-none-any.whl | Python 3 | none | any | Details for httpie_auth_store-4.0.0-py3-none-any.whl |
Total release size: 20.3 kB
Release files / httpie_auth_store-4.0.0.tar.gz
| Download URL | httpie_auth_store-4.0.0.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2d1b3ddb03600658b7d1e202aa2d63bf5f7572686994294063b3a02bea471ea0
|
|
BLAKE2b-256 checksum How to use checksums |
8f6532fcb4959c8acac54dadb7a3f399907b374732a19d827d52c667e1703a22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1022-azure
|
Release files / httpie_auth_store-4.0.0-py3-none-any.whl
| Download URL | httpie_auth_store-4.0.0-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9d2be0284ace8fa286042e3142d5f968d0c083783e49454908e021ca19c0a8b4
|
|
BLAKE2b-256 checksum How to use checksums |
45551e5d0847a36830ea624eb9805662a75cc594dc8008cc98412abaf602dae8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1022-azure
|
Security for httpie-auth-store 4.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.