Tovább a tartalomhoz

Control Center Connect referencia

A Control Center Connect futtatja a szolgáltatói bejelentkezéseket azoknak a szervereknek, amelyek nem regisztráltak saját alkalmazást. Egy szerver vagy a Control Center által üzemeltetett Connectet használja, vagy egy olyat, amelyet a szervezete futtat (Connect-szerver futtatása), vagy egyiket sem. A választás a Beállítások → Szerver → Egyszeri bejelentkezés → Control Center Connect helyen, a cc_server connect paranccsal vagy a CC_CONNECT_URL változóval adható meg. Egy munkaterület ezt követi, hacsak egy adminisztrátor másikat nem választ az adott munkaterületre a Beállítások → Munkaterület → Integrációk alatt (Munkaterületenkénti választás).

Minden szolgáltató egy sáv. A Saját alkalmazások használata (vagy ha még nincs választás) alatt egy sáv a szerver saját alkalmazásán fut, ha az teljesen be van állítva, egyébként nem érhető el. A Control Center vagy egyéni Connect esetén a Connect minden általa kiszolgált sávot kezel: a szerver saját alkalmazásai mentve maradnak, de nem használatosak sem bejelentkezéshez, sem szerveroldali automatizáláshoz, sem a szerver által jelentett állapothoz. A munkaterület, amely saját választást tett, minden sávot a saját választása szerint futtat.

Sáv Saját alkalmazáshoz kell A Connecten keresztül
github Alkalmazás-ID, privát kulcs, kliens-ID és kliens titok Az emberek a megosztott GitHub Appba jelentkeznek be
google Kliens-ID és kliens titok Az emberek Google Calendart csatlakoztatnak
linear Kliens-ID Az emberek bejelentkeznek a Linearbe
linear_app Kliens-ID Egy munkaterület-adminisztrátor csatlakoztatja a Linear alkalmazásszereplőjét
slack A munkaterület saját Slack-alkalmazásának kapcsolata Egy munkaterület-adminisztrátor a megosztott Slack-alkalmazáshoz csatlakoztatja a Slacket
klipy KLIPY_APP_KEY GIF-keresés a Connect proxyján keresztül

A csak részben beállított saját alkalmazás hibává teszi a sávját, soha nem vált csendben a Connectre. A Saját alkalmazások használata alatt álló munkaterület soha nem megy át a szerver alkalmazásain vagy bármely Connecten, egyetlen szolgáltatóhoz sem. A szerver Connect-választásának megváltoztatása senkit sem jelentkeztet ki olyan munkaterületről, amely saját választást tett.

A Connect látja A Connect soha nem látja
A szerver telepítési azonosítóját és a kérésaláírásokat A forráskódot, a repók tartalmát, a diffeket vagy a pull requestek szövegét
A bejelentkezett szolgáltatói fiókot, a bejelentkezés alatt A jegyeket, az átiratokat vagy bármit egy munkaterület adatbázisában
Hogy egy hitelesítő adat melyik munkaterülethez tartozik, átlátszatlan azonosítóként a pecséten belül A szerver saját alkalmazásainak titkai: soha nem hagyják el a szervert
A repót, amelyhez egy egyetlen repóra szóló GitHub-token készül A frissítő tokeneket nyugalmi állapotban: csak a szerver által őrzött pecsétekben léteznek
A szerverhez kötött Slack-csapat A Linear-titkokat: a Linear kódját a szerver maga cseréli be
A GIF-keresési kifejezéseket, amikor a Klipy proxyjaként működik A jelszavakat, a párosítási kulcsokat vagy a modellszolgáltatói kulcsokat
A Slack-eseményhivatkozásokat (csapat, csatorna, üzenetazonosító) és a slash-parancsok szövegét A Slack-üzenetek szövegét: a Connect érkezéskor eldobja, és a szerver maga olvassa ki az üzenetet a Slackből

A folyamatban lévő bejelentkezéseket, a nonce-okat és a gyorsítótárakat a Connect legfeljebb 10 percig őrzi, az óránkénti használati számlálókat pedig legfeljebb két óráig. Az egy repóra szóló, személyként kiállított GitHub-token addig marad nyilvántartva, lepecsételve ahhoz a bejelentkezéshez, amely kérte, amíg le nem jár (legfeljebb 8 óra), így a Connect újra kiadhatja, és leválasztáskor visszavonhatja. Egyetlen tartós nyilvántartása a Slack-kötések (melyik szerverhez kötődik az egyes Slack-csapatok) és a visszavont telepítési azonosítók. A hibák kódot hordoznak, soha nem a szolgáltató válaszát. A naplók a telepítési azonosítókat csak kulcsolt hashként rögzítik, a GitHub-tokent pedig csak a hashed_token értékként, amelyet a GitHub szervezeti audit-naplója mutat hozzá, így a szervezet tulajdonosa össze tudja párosítani a kettőt.

Mód Beállítás Viselkedés
Nincs megadva Új szerver Egyetlen sáv sem használja a Connectet. A bevezetés választást kér a szerver tulajdonosától
hosted A Control Center alkalmazásainak használata https://connect.usectrl.dev, offline aláírt konfigurációval. A szerver saját alkalmazásai nincsenek használatban
custom Egyéni Connect-szerver használata Connect egy HTTPS URL-en (http csak loopbacken), az első használatkor megbízhatónak tekintve. A szerver saját alkalmazásai nincsenek használatban
off Saját alkalmazások használata Egyetlen sáv sem használja a Connectet. Csak a saját alkalmazások jelentkeztetik be az embereket

A szerver környezetében vagy .env fájljában megadott CC_CONNECT_URL rögzíti a választást: hosted, off vagy egy Connect-URL. A Beállítások ekkor mutatják a zárolást, és nem módosíthatják.

Ebbe a buildbe nincs befordítva üzemeltetett konfigurációs kulcs, így az üzemeltetett mód hosted_unprovisioned állapotot jelez, és egyetlen sávot sem szolgál ki. A saját alkalmazások és az egyéni Connect működnek.

Az üzemeltetett Connect egyetlen konténerben fut. A lepecsételő kulcsa és a közös GitHub App privát kulcsa ott környezeti változók, nem olyan kulcstárban lévő kulcsok, amelyek csak aláírásra vagy visszafejtésre szolgálnak, ahogy a GitHub egy App privát kulcsához javasolja. Ez a jelenlegi beállítás ismert hiányossága.

A szerver legfeljebb 10 percenként olvassa a Connect konfigurációját, és hívásonként legfeljebb 5 másodpercet vár. Ha a Connect nem érhető el, az utolsó jó konfiguráció marad használatban, és a Beállítások elavultként jelölik.

A Beállítások → Munkaterület → Integrációk → Control Center Connect felülbírálja a szerver választását egyetlen munkaterületen. Minden tag látja, és azt is, hol fut az egyes bejelentkezések; csak a munkaterület adminisztrátora módosíthatja.

Választás Működés
Mint ez a szerver Az alapértelmezés. A munkaterület arra a választásra támaszkodik, amit a szerver tulajdonosa beállított; a választás neve megjelenik
A Control Center alkalmazásainak használata A Control Center üzemeltetett Connectje, függetlenül attól, mit használ a szerver
Saját alkalmazások használata Csak a munkaterület saját alkalmazásai: GitHub App, Google-kliens, Linear-alkalmazás, Klipy-kulcs és Slack-alkalmazás. Szolgáltató saját alkalmazás nélkül itt ki van kapcsolva; részben beállított alkalmazás beállítási hiba
Egyéni Connect-szerver használata Connect a munkaterület által megadott HTTPS-címen. Privát vagy helyi hálózaton lévő címek elutasítva
  • A Mint ez a szerver választástól eltérő bármely választás minden személy GitHub- és Linear-bejelentkezését a munkaterület saját terében tartja, így azok sosem keverednek a szerverszintű bejelentkezésekkel
  • A váltás előzetes megerősítést kér: a munkaterület minden tagjának újra be kell jelentkeznie GitHubra, Linearba és a Google Calendarba az új alkalmazásokon keresztül
  • A munkaterület saját Slack-kapcsolata minden választás mellett működik; a A Control Center hozzáadása ide: Slack a választást követi
  • A CC_CONNECT_URL a munkaterületeknek sem enged saját Connectet: követhetik a szervert, vagy használhatják saját alkalmazásaikat
  • A munkaterület egyéni Connectje csak az adott munkaterületen bizalmi az első használatkor: az Új alkalmazások elfogadása ott sosem változtat azon, amit a szerver vagy más munkaterület megbízhatónak tart
Elem Mi ez
Telepítési kulcs 32 bájtos mag a szerver titokfájljában (connect_install_key), az eszközpárosítási kulcsoktól elkülönítve
Connectenkénti kulcs A magból és a Connect címéből származtatott Ed25519-kulcs. Minden Connect felé irányuló kérés ezzel van aláírva (RFC 9421)
Telepítési azonosító Ebből a nyilvános kulcsból származtatott 26 karakter. A Beállítások és a cc_server connect status mutatja

Ugyanannak a szervernek minden Connect-címhez más telepítési azonosítója van. Az azonosító csak a kulcs cseréjekor változik.

A Connecten keresztüli bejelentkezés egy hitelesítőadat-pecsétet ad vissza: egy titkosított blobot, amelyet csak az a Connect tud megnyitni, amely készítette. A szolgáltatóhoz, a Connect címéhez, a telepítési azonosítóhoz, a munkaterülethez, a szolgáltatói fiókhoz, az alkalmazáshoz és a titokgenerációhoz kötött.

  • A szerver a pecsétet és azt a telepítési azonosítót tárolja, amelyhez lepecsételték. A hozzáférési tokenek a memóriában maradnak
  • Frissítéskor a szerver visszaküldi a pecsétet, és új hozzáférési tokent és új pecsétet kap
  • Az a pecsét, amelynek telepítési azonosítója vagy Connect-címe már nem egyezik, a következő olvasáskor törlődik, és az adott személy újra bejelentkezik. Ez kulcscsere, egy másik Connectre váltás vagy az adatkönyvtár egy másik szerverre való visszaállítása után történik
  • Az a pecsét, amelyet a Connect nem tud megnyitni, access_denied hibával elutasításra kerül

A megosztott GitHub App egy telepítését bármely szerverről lehet használni. A Connect nem vezet nyilvántartást arról, mely szerver használhatja.

  • A GitHub-alkalmazás telepítése a Beállítások → Munkaterület → Integrációk helyen megnyitja az alkalmazás telepítési oldalát a GitHubon. A hivatkozást a szerver a Connect konfigurációjában szereplő alkalmazásnévből állítja össze
  • Egy egyetlen repóra szóló tokenhez szükséges, hogy az alkalmazás telepítve legyen a repó tulajdonosánál, és a bejelentkezett személynek legyen hozzáférése a repóhoz. Ez a személy saját tokenje, a szerepköréhez igazítva, soha nem többet
  • Egy szervezet a GitHubon korlátozza a Control Centert: a telepítés eltávolításával, a repóinak szűkítésével vagy a személy eltávolításával
  • Olyan hívásokhoz, amelyeket csak a személy tehet meg, például a telepítéseinek listázásához, a Connect a személy saját App-felhasználói tokenjét adja át a szervernek, nem egy egyetlen repóra szóló tokent. Egy szerveren való bejelentkezés azt jelenti, hogy megbízik abban a szerverben ezzel a tokennel.
  • Az a szervezet, amely GitHub IP-engedélylistát érvényesít, nem használhatja az üzemeltetett Connectet, mert annak címei nem rögzítettek. Helyette a saját GitHub-alkalmazását regisztrálja, a saját szerverein vagy az általa futtatott Connecten.
  • Leválasztás csak azt a bejelentkezést vonja vissza: a Connect egyszer felhasználja a frissítő tokenjét, és törli, amit az visszaad, törli a felhasználói tokenjét, valamint a Connect által neki kiállított, egy repóra szóló tokeneket. Bárhol megőrzött másolata a pecsétjéről működésképtelenné válik. A személy bejelentkezései más szervereken és munkaterületeken továbbra is működnek. Ha a Control Centert egy GitHub-fiókból teljesen el akarja távolítani, a GitHubon vonja vissza a Beállítások → Alkalmazások → Engedélyezett GitHub-alkalmazások → Visszavonás alatt.

A bot nevében (as: app) kiállított tokenek ugyanazt a botot mutatják a GitHubon minden olyan szerverhez, amely ugyanazt a Connectet használja: a GitHub nem tudja megkülönböztetni ezeket a szervereket.

  • Minden szerver engedélyezheti a botnak az olvasást és a kommentelést: read, review és comment (megjegyzések, címkék, felelősök és reakciók hibajegyeken és pull requesteken)
  • Pull request átnézése botként (bot, amely pull requesteket ír) csak azoknak a szervereknek engedélyezett, amelyeket a Connect üzemeltetője a CONNECT_GITHUB_REVIEW_BOT_INSTALLS listára vett fel. Minden más szerver needs_requester választ kap, és az átnézést az elszámoltatható személy saját tokenjével teszi közzé, amelyet a GitHub az illetőre korlátoz: az átnézés az ő nevén jelenik meg. Ez fedi az MI-átnézés közzétételét, az átnézési megjegyzéseket és az átnézőkéréseket.
  • Push, ágak létrehozása és pull request nyitása (write) soha nem a közös botként kerülnek kiállításra. Mindig a kérő saját bejelentkezését használják.
  • Pull request jóváhagyása soha nincs automatizálva, egyik tokennel sem.
  • A saját GitHub App-pal rendelkező szerver vagy munkaterület ezek mindegyikében megtartja a botot, az átnézéseket is beleértve.

Amit a szervezet tulajdonosainak és tagjainak tudniuk kell

Szekció neve “Amit a szervezet tulajdonosainak és tagjainak tudniuk kell”
  • Az a szerver, amelyen valaki bejelentkezik, az ő App-felhasználói tokenjét tartja: tokenenként legfeljebb 8 óra, leválasztásig megújítva. Azokon a repókon, amelyeken a közös App telepítve van, és amelyeket elér, a nevükben tud eljárni. A Connect véglegesen levághatja a szervert (visszavont vagy megtagadott telepítés), de a már kiadott token addig érvényes, amíg le nem jár.
  • A közös GitHub App szervezetbe telepítése minden olyan Control Center-szerverre kiterjedő hozzájárulás, amelyre bármely tag bejelentkezik, nem csak egy szerverre.
  • A bot megosztott, ahogy fent is: a szervezet a GitHubon nem tudja megállapítani, melyik szerver járt el botként.
  • Az a szervezet, amely saját határt akar, saját GitHub-alkalmazást regisztrál, és saját Connectet futtat (Connect-szerver futtatása), vagy az alkalmazást a saját szerverein állítja be.
Connect Hogyan bízik meg a szerver a konfigurációjában
Üzemeltetett Egy Ed25519-aláírást ellenőriz a buildbe fordított kulcsokkal. Elutasítja a látott legmagasabbnál alacsonyabb epochot (rollback)
Egyéni Az első használatkor rögzíti a GitHub alkalmazás- és kliensazonosítóját, a Google és a Linear kliensazonosítóját, valamint a Slack alkalmazás- és kliensazonosítóját. Egy változás szünetelteti a Connectes bejelentkezéseket (pins_changed), amíg a szerver tulajdonosa meg nem nyomja az Új alkalmazások elfogadása gombot

A szerver Connect-beállításai csak a szerver tulajdonosának érhetők el.

Művelet Mit tesz
connect.status Mód, URL, zárolás, telepítési azonosító, állapot, konfigurációs epoch és az egyes sávok forrása
connect.configure Beállítja a hosted, a custom (url-lel) vagy az off értéket
connect.test Újra lekéri a konfigurációt, és jelenti az állapotot
connect.confirmPins Elfogadja egy egyéni Connect megváltozott azonosítóit
connect.rotateKey Új telepítési kulcsot és új telepítési azonosítót állít ki (a force akkor is lecseréli, ha a Connect nem tudta visszavonni a régit); lásd: A telepítési kulcs cseréje

A munkaterület saját választásának saját műveletei vannak, mindegyik megnevezi a munkaterületet:

Művelet Ki Mit tesz
workspaceConnect.status Bármely tag A választás, mire oldódik fel, a sávok állapota és forrása. A telepítési azonosító és a függőben lévő kulcsok csak adminisztrátoroknak
workspaceConnect.set Munkaterület-adminisztrátor Beállítja az inherit, hosted, custom (url-lel) vagy own értéket
workspaceConnect.test Munkaterület-adminisztrátor Újra lekéri a munkaterület Connect-konfigurációját, és jelenti az állapotot
workspaceConnect.confirmPins Munkaterület-adminisztrátor Elfogadja a munkaterület egyéni Connectjének megváltozott azonosítóit

Maguk a bejelentkezések az oauth.lanes, oauth.begin, oauth.status, oauth.complete, oauth.connections és oauth.disconnect műveletet használják. A személy mindig a bejelentkezett hívó.

  1. A szerver megkéri a Connectet a sáv elindítására, és megkapja a szolgáltató engedélyezési URL-jét, amelyet megjelenítés előtt ellenőriz. A GitHub mindig megmutatja a fiókválasztóját
  2. A személy jóváhagyja a böngészőben. A szolgáltató visszatér a Connecthez
  3. A Connect megmutatja, mit tehet a szerver, amely a bejelentkezést indította, a személy nevében, és meddig. A Connect nem tudja megállapítani, ki futtatja azt a szervert, ezért az oldal csak akkor kéri a személyt a folytatásra, ha ő maga indította a bejelentkezést, és arra kéri, zárja be, ha valaki küldte neki a hivatkozást. Ha a böngésző másik hálózaton van, mint ahonnan a bejelentkezés indult, az oldal ezt jelzi: ez egy üzemeltetett szervernél vagy másik eszköznél normális, de adathalászatra is ez jellemző. A Mégse megszakítja a bejelentkezést: a szolgáltató kódját soha nem használják fel. Minden oldal egyszer válaszol: az a válasz, amely nem a Connect által épp megmutatott oldalról érkezett, elutasításra kerül.
  4. A Folytatás után a Connect egy 8 karakteres kódot és egy control-center://oauth-done hivatkozást mutat. Aki megkapja a kódot, az épp jóváhagyott hozzáférést kapja meg, ezért a kód csak oda kerülhet, ahol a bejelentkezést indították
  5. A személy beírja a kódot az alkalmazásba, vagy megnyitja a hivatkozást. A szerver a kóddal és a kérés saját bizonyítékával veszi át a bejelentkezést

A bejelentkezés 10 perc után lejár. Öt hibás kód lezárja. Az a hivatkozás, amelyet nem ez az alkalmazás indított, elutasításra kerül ezzel az üzenettel: A bejelentkezést nem innen indították. A Connect korlátozza, hány bejelentkezést indíthat egy hálózati cím, és hány GitHub-tokent állít ki személyenként és szerverenként, személyenként a szervereken át, címenként és az egész alkalmazásra nézve. Az új bejelentkezéseknek saját keretük van, így soha nem tartják fel azokat a megújításokat, amelyekre mások várnak. A korlát túllépése esetén a hívás rate_limited hibával utasítódik el, a szerver később újrapróbálkozik, és senkit nem jelentkeztet ki. A személy korlátját túllépő bejelentkezést a GitHubon visszavonják, és elutasítják.

Csak a szerver tulajdonosa cserélheti a kulcsot, a Control Center Connect kártyán a Beállítások → Szerver → Egyszeri bejelentkezés alatt található Kulcs cseréje gombbal. Erre nincs parancs. A csere:

  • Mindenkit kijelentkeztet minden olyan sávból, amely a Connecten keresztül fut. Minden olyan Connect-szerverhez, amelyhez a régi kulcsot használták, a szerver visszavonja az onnan tartott GitHub- és Slack-bejelentkezéseket (a Google-bejelentkezésnek nincs mit visszavonnia, lejár)
  • Visszavonja a régi telepítési azonosítót minden ilyen Connect-szervernél: a régi kulccsal aláírva, és egy olyan hitelesítőadat-pecséttel igazolva, amelyet a szerver az adott Connecttől tart. Ettől kezdve a Connect minden, a régi kulccsal küldött kérést elutasít, így a pecsét vagy a régi kulcs egy másolata, amelyet ettől a szervertől vettek, használhatatlan, a régi azonosítóhoz kötött Slack-munkaterületek pedig felszabadulnak, hogy újra csatlakozhassanak. A már kiadott tokenek addig érvényesek, amíg le nem járnak (a bottokené egy óra, a személyeké nyolc óra). Ha a szerver nem tart pecsétet egy Connect-szervertől, annál nincs mit visszavonni, azt kihagyja
  • Ezután a szerver új telepítési kulcsot és új telepítési azonosítót kap
  • Ha egy Connect-szerver nem érhető el, vagy megtagadja a régi azonosító visszavonását, a szerver a kulcscsere előtt megáll, és megjeleníti a A Connect nem tudta visszavonni a régi kulcsot üzenetet. A Mindenképpen cserél gomb a kulcsot akkor is lecseréli; ekkor a régi telepítési azonosító az adott Connecten addig használható marad, amíg a tokenjei le nem járnak, GitHubnál legfeljebb 8 óráig
  • A szerver saját alkalmazásain keresztüli bejelentkezéseket érintetlenül hagyja
  • Az új telepítési azonosítót fel kell venni egy egyéni Connect engedélylistájára
Kód Jelentés
hosted_unprovisioned Ennek a buildnek nincs üzemeltetett konfigurációs kulcsa
signature Az üzemeltetett konfiguráció nem ment át az aláírás-ellenőrzésen
rollback A Connect régebbi konfigurációt szolgált ki, mint amit a szerver már látott
unreachable A szerver nem éri el a Connectet
install_blocked A Connect nem engedélyezi ezt a telepítési azonosítót, vagy visszavonták
pins_changed Egy egyéni Connect más alkalmazásazonosítókat közölt
protocol A Connect olyan formában válaszolt, amelyet ez a szerver nem ért