os-mfa
Convenient and secure OpenStack authentication and credential management inspired by broamski/aws-mfa
What problem does os-mfa solve?
First some quick background. OpenStack provides two main methods of setting credentials for programmatic authentication:
A) Environment variables set via 'openrc.sh' files
- 🛡️ Avoids storing passwords in plaintext on disk 👍
- 🤦 Session credentials are lost if you close or restart your terminal window 👎
- 🔒 Sessions can't be shared/accessed across multiple terminal sessions 👎
- 💔 Not compatible with windows clients 👎
B) clouds.yaml configuration files
- 💪 Session tokens are durable to terminal restarts/shutdowns 👍
- 💗 Compatible and consistent user experience across platforms 👍
- 🌏 OpenStack sessions are accessible in from any terminal session 👍
- 🙈 Encourages credentials to be stored in plain text 👎
- ⌛ Tokens that expire after 12 hours need to be manually refreshed and updated in clouds.yaml 👎
As we can see both have advantages and disadvantages. But what if we could have the best parts of both options?
🌈 os-mfa 🦄 leverages the convenience and durability of using clouds.yaml and automates the secure management of credentials and tokens
- 🛡️ Avoids storing passwords in plaintext on disk 👍
- 💪 Session tokens are durable to terminal restarts/shutdowns 👍
- 💗 Compatible and consistent user experience across platforms 👍
- 🌏 OpenStack sessions are accessible in from any terminal session 👍
- 🔀 Trivially switch between multiple authenticated OpenStack sessions 👍
- 🤝 Ensured compatibility with the OpenStack ecosystem 👍
Quick start
Install os-mfa
pip install -U os-mfa
Download clouds.yaml file from your OpenStack dashboard. For example
- Click API Access from the top left of the dashboard
- Click Download OpenStack RC File on the top right
- Select OpenStack clouds.yaml File from the drop down
Place the file in your current working directory (.) or an alternate location described by the docs
Linux
~/.config/openstack/clouds.yaml/etc/openstack/clouds.yaml
Windows
C:\Users\<username>\.config\openstack\clouds.yamlC:\ProgramData\openstack\clouds.yaml
E.g.
# /home/john/clouds.yaml
clouds:
catalystcloud:
auth:
auth_url: https://api.nz-hlz-1.catalystcloud.io:5000
project_id: 33735662374f4b7a9621631f2e7e5e15
project_name: acme-incorporated
user_domain_name: Default
username: john.smith@acme.com
password: 1ns3curE123!
identity_api_version: 3
interface: public
region_name: nz-hlz-1
Set $OS_CLOUD in your environment.
$ export OS_CLOUD=catalystcloud
Run os-mfa
$ os-mfa
Authenticating 'john.smith@example.com' in project 'john-smith'
Enter Password:
MFA Code (Press enter to skip): 654321
Getting token...
$ openstack network list
+--------------------------------------+------------+--------------------------------------------+
| ID | Name | Subnets |
+--------------------------------------+------------+--------------------------------------------+
| f10ad6de-a26d-4c29-8c64-2a7418d47f8f | public-net | 5063aab1-aa08-48b2-b81d-730ac732fc51, |
| | | 8a7fe804-7fbe-43d0-aa1d-cfa03034ef22, |
| | | a1549e09-4176-4322-860c-cadc68608b48 |
+--------------------------------------+------------+--------------------------------------------+
Now if you close/restart or start a new terminal window, resume your existing OpenStack session simply by exporting $OS_CLOUD again.
export OS_CLOUD=catalystcloud
What happened when we ran os-mfa?
The first time we run os-mfa is creates a "long-term" configuration in our clouds.yaml without any passwords or secrets.
Long term configurations contain the minimum information required for os-mfa to use to initialize a token based authentication.
- They should not contain any secrets such as tokens or passwords.
- They are distinguished by a suffix of
-long-term
os-mfa will then use the -long-term configuration to create a token based configuration as follows.
- Prompts the user for their password and MFA code
- Swaps the password and MFA code for an OpenStack auth token
- Updates the original configuration to use the new token for authentication
The resulting clouds.yaml should look like this
# /home/john/clouds.yaml
clouds:
catalystcloud:
auth:
auth_url: https://api.nz-hlz-1.catalystcloud.io:5000
project_id: 33735662374f4b7a9621631f2e7e5e15
project_name: acme-incorporated
token: gAAAAABkTkGx4Dah37lkiGTSEe3-r[...]9dQCVTBRsKjg6NFIYgMYRdAk7TTvIPOaaOE
identity_api_version: 3
interface: public
region_name: nz-hlz-1
catalystcloud-long-term:
auth:
auth_url: https://api.nz-hlz-1.catalystcloud.io:5000
project_id: 33735662374f4b7a9621631f2e7e5e15
project_name: acme-incorporated
user_domain_name: Default
username: john.smith@acme.com
identity_api_version: 3
interface: public
region_name: nz-hlz-1
Going further
Multiple projects, users and sessions
Since clouds.yaml supports multiple configurations, you can create configurations for any combination of
- user
- project
- region
- openstack cloud
clouds:
project1:
region: nz-hlz-1
auth:
project_name: project1
username: john.smith@acme.com
# ...
project2:
region: nz-por-1
auth:
project_name: project2
username: john.smith@acme.com
# ...
After initializing a token based authentication for each configuration using os-mfa, you can change between sessions at will
OS_CLOUD=project1
OS_CLOUD=project2
Contributing
Nothing special to report, just raise a PR
Run tests
python -m unittest discover
Building Package
Source: https://realpython.com/pypi-publish-python-package/
python -m pip install pip-tools twine
pip-compile pyproject.toml
rm -rf dist/*
python -m build
twine check dist/*
twine upload -r testpypi dist/*
twine upload dist/*
TODO
- ☑️ TBH I am probably going to port this back to python
- ☑️ Alert if no clouds.yaml found
- ☑️ Better error message if OS_CLOUD not set
- 🟦 CI/CD
- 🟦 Optionally disable prompt for MFA token
- 🟦 Store and check expiry of token
- 🟦 Only reauthenticate if token is not valid
- 🟦 -f, --force cli option to force authentication
- 🟦 more unit and integration tests
Metadata
Release files for os-mfa 0.4.2
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 |
|---|---|---|---|---|
| os-mfa-0.4.2.tar.gz | 8.7 kB | Without provenance | Details for os-mfa-0.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| os_mfa-0.4.2-py3-none-any.whl | Python 3 | none | any | Details for os_mfa-0.4.2-py3-none-any.whl |
Total release size: 17.4 kB
Release files / os-mfa-0.4.2.tar.gz
| Download URL | os-mfa-0.4.2.tar.gz |
|---|---|
| Size | 8.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dfc9373ced3da081f693ee57477d54dba07cec8648dca77fda4c61f7becb1664
|
|
BLAKE2b-256 checksum How to use checksums |
a74fc43c714541df986e8e6e6db13eb33538cc9a33d760713258e409db9d257f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Release files / os_mfa-0.4.2-py3-none-any.whl
| Download URL | os_mfa-0.4.2-py3-none-any.whl |
|---|---|
| Size | 8.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c449d6fadd36bd3e525c633e65163e71ca4110de1d1409cd71bb33110e1d88d6
|
|
BLAKE2b-256 checksum How to use checksums |
be26488f14e3d7e22f51a584078ed94ac93306f85fd2349f0a72573258859471
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.6
|
Security for os-mfa 0.4.2
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.