1password-secrets 0.0.1.dev107

1password-secrets is a set of utilities to sync 1Password secrets.

1password-secrets

1password-secrets is a CLI utility to sync 1Password secrets (env files). It enables:

• Seamless sharing of local secrets used for development. Developers starting out in a project can just use this tool to retrieve the .env file needed for local development. Likewise it is also simple to push back any local changes to the 1password vault.

• More secure and simpler method of managing Fly.io secrets. By default, Fly secrets must be managed by flyctl. This means that setting secrets in production, developers must use flyctl passing credentials via arguments - risking credentials being stored in their histories. Alternatively one must secrets in a file and run flyctl secrets import. This works well, but you must ensure everything is synched to a secret/password manager and then delete the file. 1password-secrets enables a leaner management of secrets via 1password. Via an app name, automatically finds and imports secrets in an 1password secure note to Fly. This way you ensure developers always keep secrets up-to-date and never lost files in their computer.

Motivation: Using 1password for this avoids the need for another external secret management tool. And keeps the access control in a centralised place that we already use.

Getting started

Requirements

• Install the required dependencies:

  1Password >= 8.9.13

  1Password CLI >= 2.13.1

  flyctl >= 0.0.451

  Python >= 3.10

  brew install --cask 1password 1password-cli && \
  brew install flyctl
  

  More information and installation instructions for other systems can be found in the 1password documentation.

• Allow 1Password to connect to 1Password-CLI by going to Settings -> Developer -> Command-Line Interface (CLI) and select Connect with 1Password CLI.

• Sign into your 1Password desktop and if you wish to use the fly integration, also make sure the CLI is authenticated.

Installation

In most systems (Mac and Linux) when pip3 (Python's 3 PIP) is in path and you want to install it at the user level:

pip3 install -U 1password-secrets

Otherwise you may need to install it with invoking your preferred Python version: python3 -m pip install -U 1password-secrets.

Or, even more specific python3.12 -m pip install -U 1password-secrets

Also, if your "environment is externally managed" you can bypass it with: python3 -m pip install -U --break-system-packages 1password-secrets

If you use tools like pipx or manage your environment differently adapt the installation instructions.

Usage

Local

1password-secrets will allow you to create, pull and push secrets to a 1password secure note with repo:<owner>/<repo> or local:<dir-basename> in its name. repo is used when within a valid git repository with remote "origin" set.

The remote name can be changed with the --remote switch if you use a different remote (e.g. upstream)

By default it syncs to ./.env file, this can overridden with a file_name field in 1password containing the desired relative file path.

By default it searches items across 1password vaults. Restrict the search to a single vault with the --vault switch.

• To bootstrap a 1Password secret matching the current repo/directory, run: 1password-secrets local create ./env
  Where ./env is an existing file you with to use.

• To get secrets from 1Password, run: 1password-secrets local pull

• To push the local changes to 1Password, run: 1password-secrets local push

Fly

Make sure you have a Secure Note in 1Password with fly:<fly-app-name> in the title. fly-app-name is the name of your fly application.

As with Local secrets above, you can specify a single 1Password vault by name or id with the --vault option.

• To import secrets to fly, run: 1password-secrets fly import <fly-app-name>

• Secrets can be edited directly on 1Password app or using the command: 1password-secrets fly edit <fly-app-name>

Development

• Ensure you have make installed.
• Create a virtual environment: make setup-venv.
• Install dependencies: make install-deps.

Then you can install (link) the repo globally with make local-install.

Before pushing changes ensure your code is properly formatted with make lint. Auto format the code with make format