AWS session token refreshing daemon
Project description
AWS Session daemon
This script automatically gets an MFA authenticated session using a Yubikey as MFA (multi factor authentication) and updates
~/.aws/credentials
.
As long as you've got your yubikey connected to your computer you'll never have to enter a second factor authentication code for the aws
cli. As other tools / libraries (boto3) use ~/.aws/credentials
as well you don't have to enter a token for these either.
Usage
You can install aws-session-daemon
using pip (pip install aws-session-daemon
), I recommend to install aws-session-daemon
using poetry
(poetry install aws-session-daemon
) or in a virtualenv.
Your ~/.aws/credentials
should contain your credentials and a profile with the the keys aws_access_key_id
,
aws_secret_access_key
and aws_session_token
.
For example:
~/.aws/credentials
[default]
aws_access_key_id = ...(your key id)...
aws_secret_access_key = ...(your access key)...
[profile]
aws_access_key_id = ...(placeholder, can be anything)...
aws_secret_access_key = ...(placeholder, can be anything)...
aws_session_token = ...(placeholder, can be anything)...
Your ~/.aws/credentials
will be updated in place, only the specified profile section should be touched (your comments will be safe).
Older versions are rotated up to 5 items.
Next aws-session-daemon
should be started with the following arguments:
aws-session-daemon --rolearn ... --oath_slot=... --serialnumber=... --profile_name=... --access-key-id=... --secret-access-key=... --mfa-session-duration=...
Argument | Description |
---|---|
--rolearn |
arn of the role you'd like to assume |
--oath_slot |
oath slot on your yubikey |
--serialnumber |
serial number of your MFA |
--profile_name |
profile used in ~/.aws/credentials |
--access-key-id |
access key (as obtained from IAM console) |
--secret-access-key |
secret access key (as obtained from IAM console) |
--mfa-session-duration |
duration (in seconds) for MFA session |
--credentials-section |
you can specify a different section than default in ~/.aws/credentials |
--config-section TEXT |
config section in configuration file ~/config/aws-session-daemon/config.toml |
You should only run one aws-session-daemon
process per profile, I use systemd for starting aws-session-daemon
, by using the
following unit file:
~/.config/systemd/user/aws-session-daemon@.service
[Unit]
Description=Amazon Web Services token daemon
[Service]
Type=simple
ExecStart=%h/bin/aws-session-daemon --config-section='%i'
Restart=on-failure
[Install]
WantedBy=default.target
And reload systemd using systemctl --user daemon-reload
, start aws-session-daemon
using systemctl --user start aws-session-daemon@...
If you're not so fortunate to have systemd you can also use something like supervisord
to start aws-session-daemon
.
~/supervisord.conf
[supervisord]
[supervisorctl]
serverurl=unix:///home/user/supervisord.sock
[unix_http_server]
file=/home/user/supervisord.sock
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[program:session-daemon-...]
command=/home/user/bin/aws-session-daemon --config-section=...
autorestart=true
Start supervisord using supervisord -c supervisor.conf
and start session-daemon using
supervisorctl -c supervisor.conf start session-daemon-...
.
Configuration
aws-session-daemon can also use a configuration file, the default location of
this file is ~/.config/aws-session-daemon/config.toml
. This file contains
defaults so you don't have to supply all of the arguments.
You can define multiple config-sections:
[123457890123]
mfa_oath_slot="Amazon Web Services:user@123457890123"
assume_role_arn="arn:aws:iam::123457890123:role/Other/Role"
credentials_section="123457890123"
mfa_serial_number="arn:aws:iam::123457890123:mfa/user"
[098765432101]
mfa_oath_slot="Amazon Web Services:user@098765432101"
credentials_section="098765432101"
mfa_serial_number="arn:aws:iam::098765432101:mfa/user"
If you need to assume roles from a certain AWS account you'll end up with a lot of simular entries. To make this simple the configuration can be defined hierarchical.
[[org]]
mfa_oath_slot="Amazon Web Services:user@123457890123"
assume_role_arn="arn:aws:iam::{section}:role/Other/Role"
credentials_section="123457890123"
mfa_serial_number="arn:aws:iam::123457890123:mfa/user"
[[org.098765432101]]
[[org.567890123456]]
This would be the same as the following configuration:
[098765432101]
mfa_oath_slot="Amazon Web Services:user@123457890123"
assume_role_arn="arn:aws:iam::098765432101:role/Other/Role"
credentials_section="123457890123"
mfa_serial_number="arn:aws:iam::123457890123:mfa/user"
[567890123456]
mfa_oath_slot="Amazon Web Services:user@123457890123"
assume_role_arn="arn:aws:iam::567890123456:role/Other/Role"
credentials_section="123457890123"
mfa_serial_number="arn:aws:iam::123457890123:mfa/user"
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aws-session-daemon-0.4.0.tar.gz
.
File metadata
- Download URL: aws-session-daemon-0.4.0.tar.gz
- Upload date:
- Size: 17.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.12 CPython/3.10.6 Linux/5.19.8-200.fc36.x86_64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e85301ede42a85278d44dc4f51071908e150ca43aa19f44c0ba1ded3641913c |
|
MD5 | b4b17f96c5bc34392efcfe1c83840317 |
|
BLAKE2b-256 | 8ef65f0f85f207097c7e841c7f5ebfe7614794484124dd7b9c54542e51ec1784 |
File details
Details for the file aws_session_daemon-0.4.0-py3-none-any.whl
.
File metadata
- Download URL: aws_session_daemon-0.4.0-py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.12 CPython/3.10.6 Linux/5.19.8-200.fc36.x86_64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e13b86783d45d72db91fd5e063532a1d1e99305581c997125d0272e82e8aab3 |
|
MD5 | 8762382367c9f869a06ba82d61f63b76 |
|
BLAKE2b-256 | a1d526a33a92b03f1047f255e912dc65391238a7fa5d2df9462009d471f04438 |