ENV-muutosvertailu

Testiympäristön .env-tiedoston vertaaminen tuotantoon tai tämänpäiväisen julkaisukonfiguraation vertaaminen viimeviikkoiseen silmämääräisesti on tapa, jolla todelliset käyttökatkot alkavat: puuttuva DATABASE_URL, PORT joka hiljaa muuttui, API-avain joka kierrätettiin yhdessä ympäristössä mutta ei toisessa. Molempien tiedostojen liittäminen yleiskäyttöiseen tekstivertailuun ei auta paljonkaan – se näyttää mitkä rivit eroavat, ei sitä mitkä ympäristömuuttujat todella muuttuivat, ja se tulostaa iloisesti jokaisen salaisen arvon paljaana heti kun jaat tulosteen tiimikaverille.

Tämä työkalu jäsentää molemmat tiedostot kuten dotenv ne todella lukee – yksi KEY=value-pari riviä kohden, #-kommentit ja tyhjät rivit ohitetaan, yksi- tai kaksinkertaisesti lainatut arvot puretaan lainausmerkeistä (ja ohjauskoodi puretaan vain kaksinkertaisten lainausmerkkien sisällä, täsmälleen dotenv-käytännön määrittämällä tavalla), ja valinnainen export KEY=value -etuliite sallitaan kuten shell-sourced .env-tiedostoissa käytetään. Kummastakin tiedostosta tulee siisti avain-arvo-kartta, ja näitä kahta karttaa verrataan sitten avaimittain: vain Tiedostossa A oleva on 'poistettu', vain Tiedostossa B oleva on 'lisätty', molemmissa oleva eri arvolla on 'muuttunut', ja identtiset arvot ovat 'muuttumattomia' ja piilotettuja oletusarvoisesti, jotta taulukko pysyy keskittyneenä siihen mikä todella eroaa.

Ominaisuus, joka tekee tästä turvallisen käyttää oikeiden salaisuuksien kanssa, on automaattinen maskaus. Jokainen erotustaulukossa näytettävä arvo tarkistetaan kahta itsenäistä signaalia vasten: näyttääkö sen avaimen nimi salaisuudelta (kirjainkoolla ei väliä; KEY, SECRET, TOKEN, PASSWORD, PRIVATE tai CREDENTIAL), tai onko itse arvon Shannon-entropia korkea – se informaatioteoreettinen mitta (-Σ p(c)·log₂(p(c)) arvon merkkien yli), joka erottaa API-avaimet, tokenit ja satunnaiset salasanat tilastollisesti tavallisista sanoista silloinkin kun avaimen nimi ei anna mitään vihjettä. Kumpi tahansa signaali riittää peittämään arvon kahteen ensimmäiseen ja kahteen viimeiseen merkkiinsä, laskettuna itsenäisesti jokaisen muuttuneen rivin vanhalle ja uudelle puolelle.

Kaikki – jäsennys, erojen laskenta, entropian pisteytys ja maskaus – tapahtuu täysin selaimessasi; kumpaakaan tiedostoa, eikä mitään niistä poimittua arvoa, lähetetä koskaan minnekään. Se on oikea takuu työkalulle, jonka koko tehtävä on katsoa kahta tiedostoa, jotka todennäköisesti sisältävät aitoja tietokannan tunnuksia, API-avaimia ja salasanoja vierekkäin.