Begränsade API-nycklar

Om du vill göra NuGet till en säkrare miljö för paketdistribution kan du ta kontroll över API-nycklarna genom att lägga till omfång.

Möjligheten att ange omfång för dina API-nycklar ger dig bättre kontroll över dina API:er. Du kan:

• Skapa flera omfångs-API-nycklar som kan användas för olika paket med varierande tidsramar för förfallotid.
• Skaffa API-nycklar på ett säkert sätt.
• Redigera befintliga API-nycklar för att ändra paketets tillämplighet.
• Uppdatera eller ta bort befintliga API-nycklar utan att hindra åtgärder med andra nycklar.

Varför stöder vi begränsade API-nycklar?

Vi stöder omfång för API-nycklar så att du kan ha mer detaljerade behörigheter. Tidigare erbjöd NuGet en enda API-nyckel för ett konto, och den metoden hade flera nackdelar:

• En API-nyckel för att styra alla paket. Med en enda API-nyckel som används för att hantera alla paket är det svårt att dela nyckeln på ett säkert sätt när flera utvecklare är involverade i olika paket och när de delar ett utgivarkonto.
• Alla behörigheter eller inga. Alla som har åtkomst till API-nyckeln har alla behörigheter (publicera, skicka och ta bort lista) för paketen. Detta är ofta inte önskvärt i miljöer med flera team.
• Enskild felpunkt. En enda API-nyckel innebär också en felpunkt. Om nyckeln komprometteras kan alla paket som är associerade med kontot potentiellt komprometteras. Uppdatering av API-nyckeln är det enda sättet att täppa till läckan och undvika avbrott i ditt CI/CD-arbetsflöde. Dessutom kan det finnas fall då du vill återkalla åtkomsten till API-nyckeln för en enskild person (till exempel när en anställd lämnar organisationen). Det finns inget rent sätt att hantera det här idag.

Med begränsade API-nycklar försöker vi åtgärda dessa problem samtidigt som vi ser till att inget av de befintliga arbetsflödena bryts.

Hämta en API-nyckel

1. Logga in på ditt nuget.org-konto eller skapa ett konto om du inte redan har ett.

2. Välj ditt användarnamn längst upp till höger och välj sedan API-nycklar.

3. Välj Skapa och ange ett namn för nyckeln.

4. Under Välj omfång väljer du Push.

5. Under Välj paket>Glob-mönster anger du *.

6. Välj Skapa.

7. Välj Kopiera för att kopiera den nya nyckeln.

   

Med avgränsning kan du skapa separata API-nycklar för olika syften. Varje nyckel har en tidsram för förfallotid och du kan omfångsbegränsa nyckeln till specifika paket eller globmönster. Du kan också omfångsbegränsa varje nyckel till specifika åtgärder: Push-överföra nya paket och paketversioner, push-överföra endast nya paketversioner eller ta bort listan.

Genom omfång kan du skapa API-nycklar för olika personer som hanterar paket för din organisation så att de bara har de behörigheter de behöver.

Skapa API-nycklar med avgränsat omfång

Du kan skapa flera API-nycklar baserat på dina krav. En API-nyckel kan gälla för ett eller flera paket, ha varierande omfång som beviljar specifika privilegier och har ett förfallodatum associerat med det.

I följande exempel har du en API-nyckel med namnet Contoso service CI som kan användas för att push-överföra paket för specifika Contoso.Service paket och som är giltig i 365 dagar. Det här är ett typiskt scenario där olika team inom samma organisation arbetar med olika paket, och medlemmarna i teamet får nyckeln som endast ger dem behörighet för det paket de arbetar med. Förfallodatumet fungerar som en mekanism för att förhindra inaktuella eller bortglömda nycklar.

Använda globmönster

Om du arbetar med flera paket och har en lång lista med paket att hantera kan du använda globmönster för att samtidigt välja flera paket. Om du till exempel vill bevilja specifika omfång till en nyckel för alla paket vars ID börjar med Fabrikam.Servicekan du göra detta genom att fabrikam.service.* ange i textrutan Glob-mönster .

Att använda globmönster för att fastställa API-nyckelbehörigheter gäller även för nya paket som matchar globmönstret. Om du till exempel försöker push-överföra ett nytt paket med namnet Fabrikam.Service.Frameworkkan du göra det med nyckeln som skapades tidigare, eftersom paketet matchar globmönstret fabrikam.service.*.

Skaffa API-nycklar på ett säkert sätt

För säkerhet visas aldrig en nyskapad nyckel på skärmen och är endast tillgänglig med knappen Kopiera . På samma sätt är nyckeln inte tillgänglig när sidan har uppdaterats.

Redigera befintliga API-nycklar

Du kanske också vill uppdatera nyckelbehörigheterna och omfången utan att ändra själva nyckeln. Om du har en nyckel med specifika omfång för ett enda paket kan du välja att använda samma omfång på ett eller flera andra paket.

Uppdatera eller ta bort befintliga API-nycklar

Kontoägaren kan välja att uppdatera nyckeln, i så fall är behörigheten (på paket), omfånget och förfallodatum densamma, men en ny nyckel utfärdas, vilket gör den gamla nyckeln oanvändbar. Detta är användbart vid hantering av inaktuella nycklar eller där det finns någon potential för ett API-nyckelläckage.

Du kan också välja att ta bort dessa nycklar om de inte längre behövs. Om du tar bort en nyckel tas nyckeln bort och den blir oanvändbar.

FAQs

Vad händer med min gamla (äldre) API-nyckel?

Din gamla API-nyckel (äldre) fortsätter att fungera och kan fungera så länge du vill att den ska fungera. Dessa nycklar tas bort om de inte har använts under mer än 365 dagar för att ladda upp ett paket. Mer information finns i blogginlägget Ändringar i api-nycklar som upphör att gälla. Du kan inte längre uppdatera den här nyckeln. Du måste ta bort den äldre nyckeln och skapa en ny omfångsnyckel i stället.

Hur många API-nycklar kan jag skapa?

Det finns ingen gräns för hur många API-nycklar du kan skapa. Vi rekommenderar dock att du håller det till ett hanterbart antal så att du inte får många inaktuella nycklar utan kunskap om var och vem som använder dem.

Kan jag ta bort min äldre API-nyckel eller sluta använda nu?

Ja. Du kan- och bör förmodligen ta bort din äldre API-nyckel.

Kan jag få tillbaka min API-nyckel som jag tog bort av misstag?

Nej. När du har tagit bort kan du bara skapa nya nycklar. Det går inte att återställa nycklar som tagits bort av misstag.

Fortsätter den gamla API-nyckeln att fungera vid UPPDATERING av API-nyckel?

Nej. När du uppdaterar en nyckel genereras en ny nyckel som har samma omfång, behörighet och förfallodatum som den gamla. Den gamla nyckeln upphör att existera.

Kan jag ge fler behörigheter till en befintlig API-nyckel?

Du kan inte ändra omfånget, men du kan redigera den paketlista som den gäller för.

Hur vet jag om någon av mina nycklar har upphört att gälla eller kommer att upphöra att gälla?

Om någon nyckel upphör att gälla meddelar vi dig via ett varningsmeddelande överst på sidan. Vi skickar också ett varningsmeddelande till kontoinnehavaren tio dagar innan nyckeln upphör att gälla så att du kan agera på den i god tid.