Google menggunakan teknologi AI untuk menerjemahkan konten ke dalam bahasa pilihan Anda. Terjemahan AI mungkin mengandung kesalahan.

Menggunakan Token OAuth Pihak Ketiga

Anda melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Dalam topik ini, kita akan membahas cara mengimpor token akses, token refresh, atau kode autentikasi yang dibuat secara eksternal ke dalam penyimpanan token Edge. Anda dapat menggunakan teknik ini jika ingin mengonfigurasi Apigee Edge untuk memvalidasi token yang dibuat di luar Apigee Edge.

Dalam kasus biasa, Apigee Edge akan membuat dan menyimpan token OAuth, lalu menampilkannya ke aplikasi panggilan. Aplikasi panggilan kemudian menampilkan token tersebut kembali ke Apigee Edge saat meminta layanan, dan Apigee Edge - melalui kebijakan OAuthV2 dengan Operation = VerifyAccessToken - akan memverifikasi bahwa token tersebut valid. Topik ini menjelaskan cara mengonfigurasi Apigee Edge untuk menyimpan token OAuth yang dibuat di tempat lain, sambil mempertahankan bagian verifikasi token yang sama, seolah-olah token tersebut dibuat oleh Edge.

Contoh

Jika Anda ingin melihat contoh yang berfungsi dan menggambarkan teknik yang dijelaskan dalam topik ini, lihat contoh Apigee Pengelolaan Token yang Didelegasikan.

Apa ini?

Misalnya, Anda memiliki sistem otorisasi yang ada, dan Anda ingin menggunakan nilai token atau kode yang dibuat oleh sistem tersebut sebagai pengganti nilai token atau kode OAuth2 yang dibuat oleh Edge. Anda kemudian dapat membuat permintaan proxy API yang aman dengan token atau kode yang diganti, dan Edge akan memvalidasinya seolah-olah token atau kode tersebut dibuat oleh Edge.

Beberapa Latar Belakang

Dalam kasus biasa, Apigee Edge membuat token dengan menghasilkan string huruf dan angka acak. Apigee Edge mengaitkan data lain seperti waktu token dikeluarkan, masa berlaku, daftar Produk API yang valid untuk token, dan cakupan ke token tersebut. Semua informasi ini dapat ditampilkan dalam respons yang dibuat secara otomatis oleh kebijakan OAuthV2 yang dikonfigurasi dengan Operation = GenerateAccessToken. Responsnya terlihat seperti ini:

{
  "issued_at": "1469735625687",
  "application_name": "06947a86-919e-4ca3-ac72-036723b18231",
  "scope": "urn://example.com/read",
  "status": "approved",
  "api_product_list": "[implicit-test]",
  "api_product_list_json": ["implicit-test"],
  "expires_in": "1799", //--in seconds
  "developer.email": "joe@weathersample.com",
  "token_type": "BearerToken",
  "client_id": "U9AC66e9YFyI1yqaXgUF8H6b9wUN1TLk",
  "access_token": "zBC90HhCGmGlaMBWeZAai2s3za5j",
  "organization_name": "wwitman",
  "refresh_token_expires_in": "0", //--in seconds
  "refresh_count": "0"
}

Nilai atribut access_token secara efektif adalah kunci pencarian untuk data respons. Aplikasi dapat membuat permintaan ke proxy API yang dihosting di Edge, yang membawa token pembawa zBC90HhCGmGlaMBWeZAai2s3za5j, dan Edge - dengan kebijakan OAuthV2 dengan Operation = VerifyAccessToken - akan mencari token, mengambil semua informasi, dan menggunakan informasi tersebut untuk menentukan apakah token tersebut valid atau tidak, untuk Proxy API yang diminta. Tindakan ini disebut Validasi token. Semua informasi di atas terdiri dari token. Nilai access_token hanyalah cara untuk mencari informasi tersebut.

Di sisi lain, dengan mengikuti langkah-langkah yang dijelaskan di sini, Anda dapat mengonfigurasi Edge untuk menyimpan token sehingga nilai access_token-nya adalah sesuatu yang dibuat oleh layanan eksternal. Semua metadata lainnya mungkin sama. Misalnya, Anda memiliki sistem eksternal ke Apigee Edge yang membuat token dalam bentuk "TOKEN-<16 angka acak>" . Dalam hal ini, metadata token lengkap yang disimpan oleh Apigee Edge mungkin adalah:

{
  "issued_at": "1469735625687",
  "application_name": "06947a86-919e-4ca3-ac72-036723b18231",
  "scope": "urn://example.com/read",
  "status": "approved",
  "api_product_list": "[implicit-test]",
  "api_product_list_json": ["implicit-test"],
  "expires_in": "1799", //--in seconds
  "developer.email": "joe@weathersample.com",
  "token_type": "BearerToken",
  "client_id": "U9AC66e9YFyI1yqaXgUF8H6b9wUN1TLk",
  "access_token": "TOKEN-1092837373654221",
  "organization_name": "wwitman",
  "refresh_token_expires_in": "0", //--in seconds
  "refresh_count": "0"
}

Dalam hal ini, aplikasi dapat membuat permintaan ke proxy API yang dihosting di Edge, yang membawa token pembawa TOKEN-1092837373654221, dan Edge - melalui kebijakan OAuthV2 dengan Operation = VerifyAccessToken - akan dapat memvalidasinya. Anda dapat menerapkan pola impor yang serupa ke kode otorisasi dan token refresh.

Mari Kita Bahas Validasi Kredensial Klien

Salah satu prasyarat untuk membuat token adalah memvalidasi klien yang meminta. Secara default, kebijakan OAuthV2/GenerateAccessToken di Apigee Edge secara implisit memverifikasi kredensial klien. Biasanya dalam permintaan token OAuthV2, client_id dan client_secret diteruskan di header Otorisasi, yang dienkode melalui Otorisasi Dasar HTTP (digabungkan dengan titik dua, lalu dienkode base64). Kebijakan OAuthV2/GenerateAccessToken di Apigee Edge mendekode header tersebut dan mencari client_id, serta memverifikasi bahwa client_secret yang diteruskan valid untuk client_id tersebut. Hal ini berfungsi jika kredensial diketahui oleh Apigee Edge - dengan kata lain, ada Aplikasi Developer yang disimpan dalam Apigee Edge yang berisi kredensial, yang berisi client_id dan client_secret yang diberikan.

Jika kredensial klien tidak akan divalidasi oleh Apigee Edge, Anda harus mendesain Proxy API sebelum membuat token, untuk memvalidasi klien secara eksplisit melalui cara lain. Biasanya, hal ini dilakukan melalui kebijakan ServiceCallout yang terhubung ke endpoint jarak jauh di jaringan Anda.

Dengan satu atau lain cara, baik secara implisit maupun eksplisit, Anda harus memastikan bahwa Proxy API yang membuat token, pertama-tama memvalidasi kredensial klien. Perlu diingat bahwa validasi klien tidak bergantung pada pembuatan token akses. Anda dapat mengonfigurasi Apigee Edge untuk melakukan keduanya, atau melakukan salah satu, atau tidak melakukan keduanya.

Jika Anda ingin kebijakan OAuthV2/GenerateAccessToken di Apigee Edge memvalidasi kredensial klien terhadap penyimpanan Edge, tetapkan elemen <ExternalAuthorization> ke false di dalam konfigurasi kebijakan, atau hapus sepenuhnya. Jika Anda ingin menggunakan layanan otorisasi eksternal untuk memvalidasi kredensial klien secara eksplisit, tetapkan <ExternalAuthorization> ke true.

Meskipun Apigee Edge mungkin tidak memvalidasi kredensial klien, client_id tetap harus diketahui dan dikelola oleh Apigee Edge. Setiap access_token di Apigee Edge, baik yang dibuat oleh Apigee Edge maupun yang dibuat oleh sistem eksternal lalu diimpor ke Apigee Edge, harus dikaitkan dengan aplikasi klien - yang ditunjukkan oleh client_id. Jadi, meskipun dalam kasus kebijakan OAuthV2/GenerateAccessToken di Apigee Edge tidak akan memvalidasi bahwa client_id dan client_secret cocok, kebijakan tersebut akan memvalidasi bahwa client_id valid, ada, dan tidak dicabut. Jadi, sebagai langkah penyiapan prasyarat, Anda mungkin harus mengimpor client_id melalui API administratif Edge.

Alur Kebijakan untuk OAuth pihak ketiga di Apigee

Untuk menggunakan token dari sistem OAuth pihak ketiga di Apigee Edge, alur untuk membuat token akses harus mengikuti salah satu pola berikut.

Validasi Eksternal Kredensial Klien

ServiceCallout untuk Memverifikasi kredensial klien masuk, dan mendapatkan token eksternal.
ExtractVariables atau langkah JavaScript untuk mengekstrak token yang dibuat secara eksternal dari respons.
AssignMessage untuk menetapkan variabel khusus yang dikenal sebagai oauth_external_authorization_status. Nilai harus benar (true) untuk menunjukkan bahwa kredensial klien valid.
OAuthV2/GenerateAccessToken dengan elemen <ExternalAuthorization> ditetapkan ke true, dan setidaknya salah satu dari <ExternalAccessToken>, <ExternalRefreshToken>, atau <ExternalAuthorizationCode>.

Validasi Internal Kredensial Klien

ServiceCallout untuk mendapatkan token eksternal.
ExtractVariables atau langkah JavaScript untuk mengekstrak token yang dibuat secara eksternal dari respons.
OAuthV2/GenerateAccessToken dengan elemen <ExternalAuthorization> ditetapkan ke false, dan setidaknya salah satu dari <ExternalAccessToken>, <ExternalRefreshToken>, atau <ExternalAuthorizationCode>.

Catatan tentang konfigurasi alur dan kebijakan

Jika Anda ingin menggunakan sistem eksternal untuk memvalidasi kredensial klien, itu terserah Anda untuk mengembangkan alur kebijakan yang melakukan apa yang diperlukan. Biasanya, Anda akan menggunakan a kebijakan ServiceCallout untuk mengirimkan kredensial yang dikenali secara eksternal ke layanan autentikasi eksternal. Layanan autentikasi eksternal biasanya akan menampilkan respons dan, jika kredensial valid, juga token akses.
Setelah ServiceCallout, proxy API perlu mengurai respons untuk mengekstrak status validitas, serta access_token yang dibuat secara eksternal dan mungkin refresh_token.
Dalam kebijakan OAuthV2/GenerateAccessToken, tetapkan elemen <StoreToken> ke true, dan tetapkan elemen <ExternalAuthorization> ke true atau false sesuai kebutuhan.

Saat kebijakan OAuthV2/GenerateAccessToken dijalankan, kebijakan tersebut akan membaca variabel oauth_external_authorization_status. Jika variabel ditetapkan dan nilainya benar (true), Apigee Edge tidak akan mencoba memvalidasi kredensial klien. Jika variabel tidak ditetapkan atau nilainya tidak benar (true), Apigee Edge akan mencoba memvalidasi kredensial klien.
Ada tiga elemen untuk kebijakan OAuthV2 yang memungkinkan Anda menentukan data eksternal yang akan diimpor: <ExternalAccessToken>, <ExternalRefreshToken>, dan <ExternalAuthorizationCode>. Setiap elemen ini menerima variabel alur. Kebijakan Edge akan membaca variabel tersebut untuk menemukan token akses, token refresh, atau kode otorisasi yang dibuat secara eksternal. Anda harus menerapkan kebijakan dan logika untuk menempatkan token atau kode eksternal dalam variabel yang sesuai.

Misalnya, konfigurasi berikut dalam kebijakan OAuthV2 memberi tahu Edge untuk mencari token dalam variabel konteks bernama external_token.
```
<ExternalAccessToken>external_token</ExternalAccessToken>
```
Anda juga harus memiliki langkah sebelumnya yang menetapkan variabel tersebut.

Terkait menetapkan variabel oauth_external_authorization_status, teknik umum untuk menetapkan variabel ini adalah menggunakan kebijakan AssignMessage policy dengan elemen AssignVariable, seperti ini:

<AssignMessage name="AssignMessage-SetVariable">
    <DisplayName>Assign Message - Set Variable</DisplayName>
    <AssignVariable>
        <Name>oauth_external_authorization_status</Name>
        <Value>true</Value>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

Ingat, kebijakan ini harus berada sebelum kebijakan OAuthV2 dengan Operation = GenerateAccessToken.

Contoh kebijakan OAuthV2

Kebijakan OAuthV2 berikut membuat token akses Apigee Edge jika Edge menemukan nilai token dalam variabel alur external_access_token.

<OAuthV2 name="OAuth-v20-Store-External-Token">
    <ExternalAccessToken>external_access_token</ExternalAccessToken>
    <ExternalAuthorization>true</ExternalAuthorization>
    <Operation>GenerateAccessToken</Operation>
    <GenerateResponse enabled="true">
        <Format>FORM_PARAM</Format>
    </GenerateResponse>
    <ReuseRefreshToken>false</ReuseRefreshToken>
    <StoreToken>true</StoreToken>
    <SupportedGrantTypes>
        <GrantType>client_credentials</GrantType>
    </SupportedGrantTypes>
    <ExpiresIn ref='flow.variable'>2400000</ExpiresIn>
</OAuthV2>

Biasanya, dengan jenis pemberian kredensial klien, Anda harus memberikan header Autentikasi Dasar dengan Client ID dan Client Secret yang dienkode. Namun, dalam hal ini, Anda tidak perlu memberikan header tersebut. Kebijakan ini masih mengharapkan client_id ada dalam permintaan, dan kebijakan akan memvalidasinya. Edge mengharapkan client_id dikirim sebagai bagian dari data formulir permintaan, misalnya, di request.formparam.client_id.

Secara teori, Anda dapat menerapkan pola ini dengan layanan otorisasi OAuth2 pihak ketiga mana pun.