Gestione dei segreti su GitHub

Completato

I segreti sono variabili create in un’organizzazione, un repository o un ambiente di repository. I segreti sono disponibili per l'uso nei flussi di lavoro di GitHub Actions. GitHub Actions può leggere un segreto solo se si include in modo esplicito il segreto in un flusso di lavoro.

Per i segreti archiviati a livello di organizzazione, è possibile usare i criteri di accesso per controllare quali repository possono usare i segreti dell'organizzazione. I segreti a livello di organizzazione consentono di condividere segreti tra più repository. In questo modo si riduce la necessità di creare segreti duplicati. L'aggiornamento di un segreto dell'organizzazione in un'unica posizione garantisce anche che la modifica sia effettiva in tutti i flussi di lavoro del repository che usano tale segreto.

Per i segreti archiviati a livello di ambiente, è possibile abilitare i revisori necessari per controllare l'accesso ai segreti. Un processo del flusso di lavoro non può accedere ai segreti dell'ambiente a meno che non sia stato approvato dai responsabili approvazione richiesti.

Annotazioni

È possibile configurare i flussi di lavoro per l'autenticazione diretta in Azure per accedere alle risorse.

Denominazione dei segreti

Le regole seguenti si applicano ai nomi segreti

  • I nomi possono contenere solo caratteri alfanumerici ([a-z], [A-Z], [0-9]) o caratteri di sottolineatura (_). Non sono consentiti spazi.
  • I nomi non devono iniziare con il GITHUB_ prefisso .
  • I nomi non devono iniziare con un numero.
  • I nomi non fanno distinzione tra maiuscole e minuscole.
  • I nomi devono essere univoci al livello in cui vengono creati.

Per garantire che GitHub rediegi il segreto nei log, evitare di usare i dati strutturati come valori dei segreti. Ad esempio, evitare di creare segreti contenenti BLOB JSON o Git codificati.

Accedendo ai tuoi segreti

Impostare il segreto come variabile di input o di ambiente nel file del flusso di lavoro per renderlo disponibile per un'azione. È possibile usare e leggere i segreti in un file del flusso di lavoro se si ha accesso per modificare il file. Per altre informazioni, vedere Autorizzazioni di accesso in GitHub.

I segreti dell'organizzazione e del repository vengono letti quando viene accodata un'esecuzione del flusso di lavoro e i segreti dell'ambiente vengono letti all'avvio di un processo che fa riferimento all'ambiente. È anche possibile gestire i segreti usando l'API REST.

Limitazione delle autorizzazioni per le credenziali

È consigliabile concedere le autorizzazioni minime possibili. Ad esempio, anziché usare le credenziali personali, usare le chiavi di distribuzione o un account del servizio. Valutare la possibilità di concedere le autorizzazioni di sola lettura, se necessario e limitare il più possibile l'accesso.

Quando si genera un token di accesso personale (versione classica), selezionare gli ambiti più piccoli necessari. Quando si genera un token di accesso personale con granularità fine, selezionare le autorizzazioni minime e l'accesso al repository necessario.

Creazione di segreti

Per creare segreti o variabili in GitHub per un repository di account personali, è necessario essere il proprietario del repository. Per creare segreti o variabili in GitHub per un repository dell'organizzazione, è necessario avere accesso admin. Infine, per creare segreti o variabili per un repository di account personali o un repository dell'organizzazione tramite l'API REST, è necessario disporre dell'accesso ai collaboratori.

I segreti possono essere creati da:

  • Seleziona Impostazioni nella barra di navigazione superiore del tuo repository.
  • Nella sezione Sicurezza del riquadro di spostamento a sinistra selezionare l'elenco a discesa Segreti e variabili .
  • Selezionare Azioni per accedere alla pagina Azioni segreti e variabili.

Uso di segreti in un flusso di lavoro

Per fornire un'azione con un segreto come variabile di input o di ambiente, è possibile usare il secrets contesto per accedere ai segreti creati nel repository. Il codice seguente illustra un esempio di accesso ai segreti in un flusso di lavoro.

steps:
  - name: Hello world action
    with: # Set the secret as an input
      super_secret: ${{ secrets.SuperSecret }}
    env: # Or as an environment variable
      super_secret: ${{ secrets.SuperSecret }}

Non è possibile fare riferimento direttamente ai segreti nelle condizionali if:. Prendere in considerazione l'impostazione dei segreti come variabili di ambiente a livello di processo, quindi fare riferimento alle variabili di ambiente per eseguire in modo condizionale i passaggi nel processo.

Se il valore di un segreto non è impostato, il valore restituito di un'espressione che fa riferimento al segreto , ad esempio ${{ secrets.SuperSecret }} nell'esempio, è una stringa vuota.