OpenAI
Šo lapu tulkoja mašīntulks. Skatīt oriģinālo rakstu angļu valodā.

API atslēgas drošības paraugprakse

Aizsargājiet API atslēgas, izmantojot drošu glabāšanu, piekļuves kontroli, uzraudzību, regulāru nomaiņu un IP ierobežojumus.

Atjaunināts: 3 days ago

1. Vienmēr izmantojiet unikālu API atslēgu katram konta komandas dalībniekam.

API atslēga ir unikāls kods, kas identificē jūsu pieprasījumus API. Jūsu API atslēga ir paredzēta lietošanai jums. API atslēgu kopīgošana ir pretrunā Lietošanas noteikumiem.

Sākot eksperimentēt, iespējams, vēlēsieties paplašināt API piekļuvi savai komandai. OpenAI neatbalsta API atslēgu kopīgošanu. Lūdzu, uzaiciniet jaunus dalībniekus savā kontā no lapas Dalībnieki, un pēc pierakstīšanās viņi ātri saņems savu unikālo atslēgu. Varat arī piešķirt atļaujas atsevišķām API atslēgām.

2. Izveidojiet API atslēgas ar derīguma termiņu un ieviesiet atslēgu regulāras nomaiņas procesu

Projekta atslēgas var izveidot ar derīguma termiņu, pēc kura visi ar šīm atslēgām nosūtītie pieprasījumi tiks noraidīti. Stingri iesakām izveidot atslēgas ar derīguma termiņu un ieviest regulāru atslēgu nomaiņas procesu. Pirms atslēgas derīguma termiņa beigām izveidojiet jaunu atslēgu, atjauniniet lietotnes, lai tās izmantotu jauno atslēgu, un pēc tās darbības pārbaudes atsauciet veco atslēgu. Šī prakse var ievērojami mazināt API atslēgu noplūdes sekas.

Administratori var noteikt maksimālo API atslēgu derīguma termiņu organizācijas vai projekta līmenī sadaļā Platformas iestatījumi. Jaunās atslēgas ir jākonfigurē atļautajās robežās, lai tās nevarētu palikt derīgas bezgalīgi. Projekta ierobežojumi nedrīkst pārsniegt organizācijas ierobežojumu.

3. Nekad neizvietojiet savu atslēgu klienta puses vidēs, piemēram, pārlūkprogrammās vai mobilajās lietotnēs.

Atklājot savu OpenAI API atslēgu klienta puses vidēs, piemēram, pārlūkprogrammās vai mobilajās lietotnēs, ļaunprātīgi lietotāji var to iegūt un jūsu vārdā sūtīt pieprasījumus. Tas var radīt neparedzētas izmaksas vai apdraudēt noteiktus konta datus. Pieprasījumi vienmēr ir jānovirza caur savu aizmugursistēmas serveri, kurā varat droši glabāt API atslēgu.

4. Nekad neiekļaujiet savu atslēgu repozitorijā

API atslēgas iekļaušana pirmkodā ir izplatīts akreditācijas datu apdraudēšanas veids. Ja izmantojat publiskus repozitorijus, šādi varat neapzināti padarīt savu atslēgu publiski pieejamu internetā. Privātie repozitoriji ir drošāki, taču datu aizsardzības pārkāpuma dēļ var tikt nopludinātas arī jūsu atslēgas. Tādēļ kā proaktīvu atslēgu aizsardzības pasākumu stingri iesakām izmantot vides mainīgos.

5. API atslēgas vietā izmantojiet vides mainīgos

Vides mainīgais ir mainīgais, kas tiek iestatīts operētājsistēmā, nevis lietotnē. To veido nosaukums un vērtība. Iesakām mainīgajam piešķirt nosaukumu OPENAI_API_KEY. Visā komandā konsekventi izmantojot šo mainīgā nosaukumu, varat iekļaut kodu repozitorijā un to kopīgot, neriskējot atklāt savu API atslēgu.


Windows iestatīšana

1. iespēja: iestatiet vides mainīgo ‘OPENAI_API_KEY’, izmantojot cmd komandu uzvedni

Komandu uzvednē izpildiet tālāk norādīto komandu, aizstājot <yourkey> ar savu API atslēgu:

setx OPENAI_API_KEY "<yourkey>"

Tas attieksies uz turpmāk atvērtajiem cmd uzvednes logiem, tāpēc, lai šo mainīgo izmantotu ar curl, jāatver jauns logs. Lai pārbaudītu, vai mainīgais ir iestatīts, atveriet jaunu cmd uzvednes logu un ievadiet

echo %OPENAI_API_KEY%

2. variants: iestatiet vides mainīgo “OPENAI_API_KEY”, izmantojot vadības paneli

  1. Atveriet Sistēmas rekvizītus un atlasiet Sistēmas papildu iestatījumi

Windows 10 System settings with Advanced system settings highlighted in Control Panel
  1. Atlasiet Vides mainīgie...

Windows System Properties Advanced tab with Environment Variables button highlighted
  1. Sadaļā Lietotāja mainīgie (augšā) atlasiet Jauns…. Pievienojiet nosaukuma un atslēgas vērtības pāri, aizstājot <yourkey> ar savu API atslēgu.

Mainīgā nosaukums: OPENAI_API_KEY
Mainīgā vērtība: <yourkey>

Linux/macOS iestatīšana

1. variants: iestatiet vides mainīgo “OPENAI_API_KEY”, izmantojot zsh

  1. Terminālī izpildiet tālāk norādīto komandu, aizstājot yourkey ar savu API atslēgu.

echo "export OPENAI_API_KEY='yourkey'" >> ~/.zshrc
  1. Atjauniniet čaulu ar jauno mainīgo:

source ~/.zshrc
  1. Apstipriniet, ka esat iestatījis vides mainīgo, izmantojot tālāk norādīto komandu.

echo $OPENAI_API_KEY

Jūsu API atslēgas vērtība būs iegūtais rezultāts.


2. iespēja: Iestatiet savu “OPENAI_API_KEY” vides mainīgo, izmantojot bash

Izpildiet 1. iespējas norādījumus, aizstājot .zshrc ar .bash_profile.

Viss ir gatavs! Tagad varat atsaukties uz atslēgu curl vai ielādēt to savā Python kodā:

import os
import openai

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

6. Izmantojiet atslēgu pārvaldības pakalpojumu

Ir pieejami dažādi produkti slepeno API atslēgu drošai pārvaldībai. Šie rīki ļauj kontrolēt piekļuvi atslēgām un uzlabot datu vispārējo drošību. Ja jūsu lietotnē notiktu datu aizsardzības pārkāpums, atslēgas netiktu apdraudētas, jo tās būtu šifrētas un pārvaldītas pilnīgi atsevišķā vietā.

Komandām, kas izvieto savas lietotnes produkcijas vidē, iesakām apsvērt kādu no šiem pakalpojumiem.

7. Pārraugiet konta lietojumu un vajadzības gadījumā nomainiet atslēgas

Kompromitēta API atslēga ļauj citai personai bez jūsu piekrišanas piekļūt jūsu konta kvotai. Tas var izraisīt datu zudumu, neparedzētas izmaksas, mēneša kvotas izsmelšanu un API piekļuves pārtraukumu.

Savas komandas lietojumu varat pārraudzīt lapā Lietojums. Ja jums rodas aizdomas par ļaunprātīgu izmantošanu, konta aizsardzībai varat veikt vairākas darbības:

  • Pārskatiet lietojumu, lai pārliecinātos, ka tas atbilst jūsu komandas darbam. Ja lietotājs ietilpst vairākās organizācijās (piemēram, darba un personiskajā), pārliecinieties, ka viņš ir iespējojis izsekošanu un iestatījis noklusējuma organizāciju lietojumam un izsekošanai.

  • Ja uzskatāt, ka jūsu atslēga ir nopludināta, nekavējoties nomainiet to lapā API atslēgas. Ja jūsu lietotnes darbojas produkcijas vidē, tajās būs attiecīgi jāatjaunina atslēgu vērtības.

  • Lai veiktu turpmāku izmeklēšanu, sazinieties ar mums vietnē help.openai.com.

8. Ierobežojiet API piekļuvi ar IP adrešu atļauto sarakstu

IP adrešu atļautais saraksts ļauj ierobežot, kuras IP adreses var piekļūt jūsu OpenAI API. Kad šī funkcija ir iespējota, tiek atļauti tikai pieprasījumi no konfigurētajām IP adresēm vai diapazoniem, bet visi pārējie tiek noraidīti, pat ja tajos ir derīga API atslēga.

Tas nodrošina papildu aizsardzību, garantējot, ka jūsu API var piekļūt tikai no uzticamas infrastruktūras, piemēram, jūsu aizmugursistēmas serveriem vai mākoņvides.

Plašāku informāciju skatiet rakstā IP adrešu atļautais saraksts OpenAI API vajadzībām.

Vai šis raksts bija noderīgs?