OpenAI
Ta stran je bila strojno prevedena. Oglejte si izvirni članek v angleščini.

Najboljše prakse za varnost ključa API

Zaščitite ključe API z varno hrambo, nadzorom dostopa, spremljanjem, menjavanjem in omejitvami naslovov IP.

Posodobljeno: 14 days ago

1. Za vsakega člana ekipe v svojem računu vedno uporabite edinstven ključ API.

Ključ API je edinstvena koda, ki identificira vaše zahteve do API-ja. Vaš ključ API je namenjen vaši uporabi. Deljenje ključev API je v nasprotju s Pogoji uporabe.

Ko začnete eksperimentirati, boste morda želeli razširiti dostop do API-ja na svojo ekipo. OpenAI ne podpira deljenja ključev API. Povabite nove člane v svoj račun s strani Člani in ob prijavi bodo hitro prejeli svoj edinstven ključ. Dovoljenja lahko dodelite tudi posameznim ključem API.

2. Ustvarite ključe API z datumom poteka veljavnosti in vzpostavite postopek njihovega menjavanja

Ključe projekta lahko ustvarite z datumom poteka veljavnosti, po katerem bodo vse zahteve s temi ključi zavrnjene. Močno priporočamo, da ključe ustvarite z datumom poteka veljavnosti in vzpostavite postopek njihovega rednega menjavanja. Preden ključ poteče, ustvarite nadomestnega, posodobite aplikacije, da ga bodo uporabljale, in prekličite stari ključ, ko preverite, da novi deluje. S temi ukrepi lahko močno zmanjšate posledice uhajanja ključev API.

Skrbniki lahko v nastavitvah platforme določijo najdaljše dovoljeno obdobje veljavnosti ključev API na ravni organizacije ali projekta. Novi ključi morajo biti nastavljeni v okviru dovoljenih omejitev, zato ne morejo ostati veljavni za nedoločen čas. Omejitve na ravni projekta ne smejo presegati omejitve organizacije.

Za podprte delovne obremenitve namesto shranjevanja dolgoročno veljavnega ključa API OpenAI uporabite federacijo identitet delovnih obremenitev. Vaša delovna obremenitev zamenja identiteto zaupanja vrednega ponudnika za kratkotrajni žeton za dostop do OpenAI. Nastavite namenski storitveni račun samo s tistimi dovoljenji, ki jih delovna obremenitev potrebuje.

3. Ključa nikoli ne vključite v okolja na strani odjemalca, kot so brskalniki ali mobilne aplikacije.

Če svoj ključ API OpenAI izpostavite v okoljih na strani odjemalca, kot so brskalniki ali mobilne aplikacije, ga lahko zlonamerni uporabniki pridobijo in v vašem imenu pošiljajo zahteve. To lahko povzroči nepričakovane stroške ali ogrozi določene podatke v računu. Zahteve morajo biti vedno usmerjene prek vašega zalednega strežnika, kjer lahko ključ API varno hranite.

4. Ključa nikoli ne shranite v repozitorij

Vključitev ključa API v izvorno kodo je pogost vzrok razkritja poverilnic. Pri javnih repozitorijih lahko tako svoj ključ nevede razkrijete v internetu. Zasebni repozitoriji so varnejši, vendar se lahko vaši ključi razkrijejo tudi ob kršitvi varnosti podatkov. Zato kot proaktiven ukrep za zaščito ključev močno priporočamo uporabo spremenljivk okolja.

5. Namesto ključa API uporabite spremenljivke okolja

Spremenljivka okolja je spremenljivka, ki je nastavljena v operacijskem sistemu in ne v aplikaciji. Sestavljena je iz imena in vrednosti. Priporočamo, da spremenljivko poimenujete OPENAI_API_KEY. Če v celotni ekipi dosledno uporabljate to ime spremenljivke, lahko kodo shranjujete v repozitorij in jo delite brez tveganja, da bi razkrili ključ API.


Nastavitev v sistemu Windows

1. možnost: Spremenljivko okolja »OPENAI_API_KEY« nastavite prek ukaznega poziva cmd

V ukaznem pozivu cmd zaženite naslednji ukaz, pri čemer <yourkey> zamenjajte s svojim ključem API:

setx OPENAI_API_KEY "<yourkey>"

Nastavitev bo veljala za prihodnja okna ukaznega poziva cmd, zato morate odpreti novo okno, da boste lahko to spremenljivko uporabili z orodjem curl. Ali je bila spremenljivka nastavljena, lahko preverite tako, da odprete novo okno ukaznega poziva cmd in vnesete

echo %OPENAI_API_KEY%

Možnost 2: Nastavite spremenljivko okolja »OPENAI_API_KEY« na nadzorni plošči

  1. Odprite Lastnosti sistema in izberite Dodatne sistemske nastavitve

Windows 10 System settings with Advanced system settings highlighted in Control Panel
  1. Izberite Spremenljivke okolja ...

Windows System Properties Advanced tab with Environment Variables button highlighted
  1. V razdelku Uporabniške spremenljivke (zgoraj) izberite Novo…. Dodajte par imena in vrednosti ključa, pri čemer <yourkey> zamenjajte s svojim ključem API.

Ime spremenljivke: OPENAI_API_KEY
Vrednost spremenljivke: <yourkey>

Nastavitev sistema Linux/macOS

Možnost 1: Nastavite spremenljivko okolja »OPENAI_API_KEY« z lupino zsh

  1. V terminalu zaženite naslednji ukaz in yourkey zamenjajte s svojim ključem API.

echo "export OPENAI_API_KEY='yourkey'" >> ~/.zshrc
  1. Posodobite lupino z novo spremenljivko:

source ~/.zshrc
  1. Z naslednjim ukazom potrdite, da ste nastavili okoljsko spremenljivko.

echo $OPENAI_API_KEY

Vrednost vašega ključa API bo prikazana kot rezultat.


Možnost 2: Nastavite okoljsko spremenljivko ‘OPENAI_API_KEY’ z uporabo bash

Sledite navodilom v možnosti 1, pri čemer .zshrc zamenjajte z .bash_profile.

Vse je pripravljeno! Zdaj se lahko sklicujete na ključ v curl ali ga naložite v Python:

import os
import openai

openai.api_key = os.environ["OPENAI_API_KEY"]

6. Uporabite storitev za upravljanje ključev

Za varno upravljanje skrivnih ključev API so na voljo različni izdelki. Ta orodja omogočajo nadzor dostopa do ključev in izboljšajo splošno varnost podatkov. Če bi prišlo do kršitve varnosti podatkov v vaši aplikaciji, vaši ključi ne bi bili ogroženi, saj bi bili šifrirani in upravljani na povsem ločeni lokaciji.

Ekipam, ki svoje aplikacije uvajajo v produkcijo, priporočamo uporabo ene od teh storitev.

7. Spremljajte porabo v svojem računu in po potrebi menjajte ključe

Za svojo organizacijo ali projekte nastavite mesečne omejitve porabe in omogočite njihovo strogo uveljavljanje, da omejite nepričakovane stroške zaradi uhajanja ključa. Sama opozorila o porabi ne ustavijo prometa API. Strogo uveljavljanje omejitev lahko blokira tudi legitimne zahteve, poraba pa lahko nekoliko preseže omejitev, ker se ta ne uveljavi v trenutku.

Zlorabljen ključ API drugi osebi omogoča, da brez vašega soglasja uporablja kvoto vašega računa. To lahko povzroči izgubo podatkov, nepričakovane stroške, izčrpanje vaše mesečne kvote in prekinitev dostopa do API-ja.

Porabo svojih ekip lahko spremljate na strani Poraba. Če vas skrbi morebitna zloraba, lahko svoj račun zaščitite z naslednjimi ukrepi:

  • Preglejte porabo in preverite, ali je skladna z delom vaše ekipe. Pri uporabnikih, ki pripadajo več organizacijam (npr. službeni in osebni), preverite, ali so omogočili sledenje in nastavili privzeto organizacijo za porabo in sledenje.

  • Če menite, da je vaš ključ ušel, ga takoj zamenjajte na strani Ključi API. Če imate aplikacije v produkcijskem okolju, boste morali ustrezno posodobiti vrednosti ključev.

  • Za nadaljnjo preiskavo se obrnite na nas prek strani help.openai.com.

8. Zaščitite dostop do API-ja z omrežnimi kontrolami

S seznamom dovoljenih naslovov IP lahko omejite, kateri naslovi IP lahko dostopajo do vašega API-ja OpenAI. Ko je ta možnost omogočena, so dovoljene le zahteve z nastavljenih naslovov IP ali obsegov naslovov, vse druge pa so zavrnjene – tudi če vsebujejo veljaven ključ API.

To zagotavlja dodatno raven zaščite, saj je dostop do vašega API-ja mogoč le iz zaupanja vredne infrastrukture, kot so vaši zaledni strežniki ali okolje v oblaku.

Za več informacij si oglejte članek o seznamu dovoljenih naslovov IP za API OpenAI.

Private Link je še ena možnost za organizacije, ki potrebujejo dostop prek zasebnega omrežja. Delovnim obremenitvam v okolju Azure omogoča povezovanje z regionalnimi končnimi točkami API-ja OpenAI prek storitve Azure Private Link. Za dostop se obrnite na svojega predstavnika OpenAI ali prodajno ekipo. Preverjanje pristnosti za API je še vedno obvezno, Private Link pa ni združljiv s seznamom dovoljenih naslovov IP ali vzajemnim TLS (mTLS). Podrobnosti o nastavitvi najdete v vodniku za Private Link.

Ali vam je bil ta članek v pomoč?