Metadata-Version: 2.4
Name: aws-xfa
Version: 1.0.0
Summary: AWS MFA credential helper — exchange long-term credentials for temporary STS tokens
Project-URL: Homepage, https://github.com/karmazin-me/aws-xfa
Project-URL: Repository, https://github.com/karmazin-me/aws-xfa
Project-URL: Issues, https://github.com/karmazin-me/aws-xfa/issues
Author-email: Eugene Karmazin <awsxfa@icloud.com>
License: 0BSD
License-File: LICENSE
Keywords: 1password,aws,cli,credentials,mfa,sts
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Zero-Clause BSD (0BSD)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Security
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.9
Requires-Dist: boto3
Description-Content-Type: text/markdown

  aws-xfa

# aws-xfa

Exchange long-term AWS credentials for temporary STS tokens — handles MFA automatically, integrates with 1Password, and can run as a background daemon that keeps credentials fresh without any manual steps.

## Install

```sh
pip install aws-xfa
```

## First run

If you don't have `~/.aws/credentials` yet, just run:

```sh
aws-xfa
```

It will prompt you for everything:

```
AWS Access Key ID: AKIA...
AWS Secret Access Key: ************
MFA device ARN (e.g. arn:aws:iam::123456789012:mfa/username): arn:aws:iam::...
AWS region (e.g. us-east-1): us-east-1
Use 1Password CLI to automatically fetch MFA codes? [y/N]:
```

Then it calls AWS STS and writes your temporary credentials to `~/.aws/credentials`.

## Existing credentials file

If you already have `~/.aws/credentials` with a `[default]` section, aws-xfa will migrate it automatically — creating `[default-long-term]` for your permanent keys, and using `[default]` for the temporary STS credentials.

Your credentials file structure after setup:

```ini
[default-long-term]
aws_access_key_id     = AKIA...          # your permanent keys — never exposed to AWS CLI
aws_secret_access_key = ...
aws_mfa_device        = arn:aws:iam::123456789012:mfa/username

[default]
aws_access_key_id     = ASIA...          # temporary — written by aws-xfa after each STS call
aws_secret_access_key = ...
aws_session_token     = ...
aws_security_token    = ...
expiration            = 2026-03-04 22:00:00
```

## Daily usage

```sh
aws-xfa
# Enter AWS MFA code for device [...]: 123456
# Success! Your credentials will expire in 12h 0m 0s at: 2026-03-05 10:00:00 UTC
```

Running again while credentials are still valid does nothing:

```sh
aws-xfa
# Your credentials are still valid for 11h 55m 34s, they will expire at ...
```

For a named profile (`[work-long-term]` → `[work]`):

```sh
aws-xfa work
```

Force refresh before expiry:

```sh
aws-xfa --force
aws-xfa work --force
```

## 1Password integration

Skip manual OTP entry entirely. If you answered `y` during setup, you're already configured. To enable it later:

```sh
aws-xfa --1pass
# Enter 1Password item name for profile 'default': AWS MFA
```

The item name is saved to `~/.config/aws-xfa/config.json`. **From then on, aws-xfa fetches the OTP automatically on every run** — no `--1pass` flag needed.

```sh
aws-xfa           # OTP fetched from 1Password silently
aws-xfa work      # same for named profile
```

Requires the [`op` CLI](https://developer.1password.com/docs/cli/) to be installed and signed in. If `op` fails, aws-xfa falls back to prompting you manually.

## Auto-refresh daemon

Keep credentials fresh in the background — no manual intervention ever. The daemon wakes 5 minutes before expiry and renews automatically.

**Requires 1Password** to be configured for the profile first (the daemon runs unattended).

```sh
aws-xfa daemon install default   # configure 1Password if needed, then install and start
aws-xfa daemon status default    # show running status
aws-xfa daemon stop default      # stop without removing config
aws-xfa daemon delete default    # stop and remove all artifacts and logs
```

What gets installed per platform:

| Platform | Persistence method |
|----------|--------------------|
| macOS    | LaunchAgent plist (`~/Library/LaunchAgents/com.user.aws-xfa-daemon-PROFILE.plist`) |
| Linux    | systemd user unit (falls back to double-fork on systems without systemd) |
| Windows  | detached process + `schtasks` on-logon scheduled task |

Error logs: `~/.config/aws-xfa/errors-PROFILE.log`

On Linux without systemd (Alpine, OpenRC, WSL), the daemon won't survive reboot automatically. The install command prints the command to add to your init scripts.

## Options

| Flag | Description |
|------|-------------|
| `--force` | Refresh even if credentials are still valid |
| `--1pass` | Configure 1Password for this profile (one-time setup) |
| `--duration SECONDS` | Session duration (default: 43200 = 12 h, min: 900, max: 129600) |
| `--log-level debug` | Verbose output |

Environment variables:

| Variable | Effect |
|----------|--------|
| `MFA_STS_DURATION` | Session duration (same as `--duration`) |
| `AWS_REGION` / `AWS_DEFAULT_REGION` | Region used for the STS endpoint |
| `AWS_SHARED_CREDENTIALS_FILE` | Override the default `~/.aws/credentials` path |
| `AWS_CONFIG_FILE` | Override the default `~/.aws/config` path |

CLI flags take precedence over environment variables.

## Before you use this tool

Please read these before deploying aws-xfa in any environment:

- [DISCLAIMER.md](DISCLAIMER.md) — no warranty; you are responsible for your AWS credentials and account security
- [SECURITY.md](SECURITY.md) — how to report vulnerabilities
- [LICENSE](LICENSE) — Zero-Clause BSD (0BSD)
- [CONTRIBUTING.md](CONTRIBUTING.md) — how to contribute
