hasura/graphql-engine

Add support for Docker Secrets by reading secrets files

Open

#3 989 ouverte le 2 mars 2020

Voir sur GitHub
 (19 commentaires) (27 réactions) (1 assigné)TypeScript (2 787 forks)batch import
a/securityc/serverhelp wantedk/enhancement

Métriques du dépôt

Stars
 (31 371 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Currently, the only way to pass secrets (DB credentials, Hasura admin secret) to Hasura is only by environment variables. For users of Docker Compose or Docker Swarm, this means these secrets have to be stored in plaintext, which presents security risks.

It would be great to build support for Docker Secrets (or even Vault), by adding the following environment variables, as recommended by Docker:

  • HASURA_GRAPHQL_ACCESS_KEY_FILE
  • HASURA_GRAPHQL_DATABASE_URL_FILE

If these variables are present, the access key and DB URL should be read from the corresponding files.

Docs: https://docs.docker.com/engine/swarm/secrets/#build-support-for-docker-secrets-into-your-images

Guide contributeur

Direction de recherche
Étudiez le mécanisme actuel de chargement des variables d'environnement dans la base de code de Hasura GraphQL Engine, probablement dans les scripts de démarrage du serveur ou le module de configuration. Recherchez la gestion existante de HASURA GRAPHQL ACCESS KEY et HASURA GRAPHQL DATABASE URL. Implémentez la logique pour vérifier les variantes FILE et lire le contenu des chemins de fichiers spécifiés. Consultez la documentation Docker pour les bonnes pratiques. Prenez en compte les cas limites comme les fichiers manquants, les permissions et les chemins relatifs. L'issue comporte 19 commentaires qui peuvent contenir des conseils supplémentaires.
Stack technique
docker
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
DockerGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75