theskumar / theskumar/python-dotenv

Support encryption of .env file

Abierto
#524 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
8.9k
Forks
581
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Working in a high security environment it is sometimes concerning to have a .env file sitting on your machine with plaintext credentials needed for development. It is also cumbersome to regularly recreate the .env file per working session if the credentials are particularly sensitive. One possible solution would be to support pgp encryption of the .env file, so a call to load dotenv would look like:

from dotenv import load_dotenv

load_dotenv(encrypted=True)

Right now I'm using some boilerplate code like this:

from os import getenv
from io import StringIO
from gnupg import GPG
from dotenv import load_dotenv

# encrypted with `gpg -o .env.gpg -e --default-recipient-self .env`
with open("test.env.gpg", "rb") as f:
    env_vars = GPG().decrypt_file(f)

if not env_vars.ok:
    raise Exception(f"Decryption failed: {env_vars.status}")

load_dotenv(stream=StringIO(env_vars.data.decode()))

foo = getenv("FOO")
print(f"FOO: {foo}")

This way the decrypted credentials will only ever exist in memory and since I use a yubikey to store my private keys, there is no way to access that key and retrieve those credentials without the physical key.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Start at the load_dotenv entry point and review how the existing stream-based loading path could relate to an encrypted .env input. The issue's example uses PGP decryption and gnupg, so clarify the supported decryption interface and dependency expectations before implementation. Done should allow encrypted credentials to be loaded without requiring a plaintext .env file on disk.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
security
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.