Segreti

Un progetto Restorm è fatto per essere messo sotto commit. I segreti, invece, non devono mai entrarvi. Il tipo di valore Segreto risponde a questa esigenza: la variabile registra un riferimento a una sorgente, mai il valore stesso.

Come funziona

Occorre scegliere il tipo Segreto su una variabile, poi la sorgente. Il file di progetto contiene allora soltanto l’identificatore della sorgente e i suoi parametri. Il valore viene risolto nel processo principale, al momento dell’esecuzione.

Due variabili d’ambiente di tipo Segreto (petstore_auth_token, api_key): la cella porta il marcatore $= e i pulsanti aggiorna, modifica il recupero e blocca — accanto a una variabile di tipo stringa

Che cosa protegge il tipo Segreto

Un segreto resta consultabile dall’applicazione: l’editor degli ambienti, le viste con il valore risolto, la console interna e gli snippet di codice ne mostrano il valore. È un segreto dell’utente, che lo conosce già: il tipo Segreto non cerca di nasconderlo.

Ciò che garantisce è che il valore:

non entri mai nei file che lasciano la macchina — non viene scritto nel progetto .restorm, quindi non viene messo sotto commit, né inviato a un repository, né incluso in un’esportazione;
non venga trasmesso a un servizio di terze parti non autorizzato — le destinazioni in uscita passano dal firewall.

Le sorgenti disponibili

Variabile d’ambiente del sistema (`envVar`)

Legge una variabile d’ambiente del sistema operativo. Un unico parametro: il nome della variabile.

È la sorgente da preferire in integrazione continua: il segreto viene iniettato dal vault della CI, Restorm si limita a leggerlo.

export API_TOKEN="…"
restorm --open projet.restorm --run "Tests" --headless

File di segreti (`envFileSecret`)

Legge — e scrive — un file restorm.env collocato accanto al progetto. È la modalità locale: il file resta sulla macchina e va aggiunto al .gitignore.

A differenza della sorgente precedente, questa è scrivibile: è possibile inserire il valore da Restorm, che viene registrato nel file di segreti e non nel progetto.

Aggiornare i segreti

I valori risolti vengono messi in cache. Dopo aver cambiato un segreto dall’esterno (rotazione di un token, modifica del file .env), usare Aggiorna l’ambiente per svuotare la cache e rileggere tutte le sorgenti.

Che cosa viene depurato

Restorm depura i segreti da ciò che scrive su disco:

i token prodotti da una richiesta di autenticazione vengono depurati nella cronologia delle risposte, corpo e header compresi;
anche i log applicativi vengono depurati.

Gli strumenti MCP, invece, ricevono il valore risolto, esattamente come il resto dell’applicazione: l’agente pilota Restorm per conto dell’utente, sui suoi stessi segreti. Le garanzie qui sopra restano invariate — il valore non viene scritto né nel progetto né in un’esportazione, e non parte verso un servizio di terze parti non autorizzato.

Buone pratiche

Aggiungere restorm.env e *.responses.zip al proprio .gitignore.
In CI, usare envVar anziché il file di segreti.
La password di un protocollo nativo (MQTT, AMQP, Redis, Kafka) accetta anch’essa un valore di tipo Segreto — non scrivere queste password in chiaro nella richiesta.