服務認證

與Adobe Experience Manager (AEM as a Cloud Service)的整合必須能夠安全地向AEM服務進行驗證。 AEM的Developer Console會授與服務憑證的存取權,這些憑證可用來促進外部應用程式、系統和服務透過HTTP以程式設計方式與AEM作者或Publish服務互動。

AEM與使用S2S OAuth (透過Adobe Developer Console管理)的其他Adobe產品整合。 對於與服務帳戶的自訂整合,在AEM Developer Console中使用和管理JWT憑證。

服務認證可能會顯示類似於本機開發存取權杖,但在幾個關鍵方面不同:

  • 服務認證與技術帳戶相關聯。 技術帳戶可使用多個服務認證。
  • 服務認證​ 不是 ​存取權杖,而是用於​ 取得 ​存取權杖的認證。
  • 服務憑證更具永久性(其憑證每365天過期一次),且除非被撤銷,否則不會變更,而本機開發存取權杖每天都會過期。
  • AEM as a Cloud Service環境的服務憑證對應至單一AEM技術帳戶使用者,而本機開發存取權杖會針對產生存取權杖的AEM使用者進行驗證。
  • AEM as a Cloud Service環境最多可以有10個技術帳戶,每個帳戶都有自己的服務憑證,每個憑證對應到分散的技術帳戶AEM使用者。

服務憑證及其產生的存取權杖,以及本機開發存取權杖,都應保密。 這三者皆能用來取得各自AEM as a Cloud Service環境的存取權。

產生服務認證

服務認證產生分為兩個步驟:

  1. 由Adobe IMS組織管理員建立的一次性技術帳戶
  2. 下載及使用技術帳戶的服務認證JSON

建立技術帳戶

服務憑證與本機開發存取權杖不同,需要技術帳戶先由Adobe組織IMS管理員建立,才能下載。 應為需要程式化存取AEM的每個使用者端建立獨立技術帳戶。

建立技術帳戶

技術帳戶只建立一次,不過隨著時間推移,可管理使用私密金鑰來管理與技術帳戶相關聯的服務認證。 例如,新的私密金鑰/服務認證必須在目前私密金鑰到期之前產生,以允許服務認證的使用者不受中斷地存取。

  1. 確定您是以下列身分登入:

    • Adobe IMS組織的系統管理員
    • AEM作者 ​上的​ AEM管理員 IMS產品設定檔的成員
  2. 登入AdobeCloud Manager

  3. 開啟包含AEM as a Cloud Service環境的程式,以整合設定的服務認證

  4. 點選​ 環境 ​區段中環境旁的省略符號,然後選取​ Developer Console

  5. 點選「整合」標籤

  6. 點選​ 技術帳戶 ​標籤

  7. 點選​ 建立新的技術帳戶 ​按鈕

  8. 技術帳戶的服務認證已初始化並顯示為JSON

AEM Developer Console — 整合 — 取得服務認證

初始化AEM as Cloud Service環境的服務憑證後,您Adobe IMS組織中的其他AEM開發人員就可以下載這些憑證。

下載服務認證

下載服務認證

下載服務憑證的步驟與初始化類似。

  1. 確定您是以下列身分登入:

    • Adobe IMS組織管理員
    • AEM作者 ​上的​ AEM管理員 IMS產品設定檔的成員
  2. 登入AdobeCloud Manager

  3. 開啟包含AEM as a Cloud Service環境的程式以與整合

  4. 點選​ 環境 ​區段中環境旁的省略符號,然後選取​ Developer Console

  5. 點選「整合」標籤

  6. 點選​ 技術帳戶 ​標籤

  7. 展開要使用的​ 技術帳戶

  8. 展開將下載其服務認證的​ 私密金鑰,並確認狀態為​ 使用中

  9. 點選與​ 私密金鑰 ​相關聯的​ > 檢視,這會顯示服務認證JSON

  10. 點選左上角的下載按鈕以下載包含服務憑證值的JSON檔案,並將檔案儲存到安全位置

安裝服務認證

服務憑證提供產生JWT所需的詳細資訊,此資訊會交換用來向AEM as a Cloud Service驗證的存取權杖。 服務認證必須儲存在安全位置,可供外部應用程式、系統或使用此認證來存取AEM的服務存取。 每個客戶管理服務認證的方式和位置都是唯一的。

為簡化起見,本教學課程透過命令列傳入服務認證。 然而,請與您的IT安全團隊合作,瞭解如何根據貴組織的安全方針,儲存及存取這些認證。

  1. 下載的服務認證JSON複製到專案根目錄中名為service_token.json的檔案
    • 請記住,絕對不要將​ 任何認證 ​認可給Git!

使用服務認證

服務憑證是完整格式的JSON物件,與JWT或存取權杖不同。 而是使用服務認證(包含私密金鑰)來產生JWT,再與Adobe IMS API交換存取權杖。

服務認證 — 外部應用程式

  1. 將服務認證從AEM Developer Console下載至安全位置
  2. 外部應用程式需要以程式設計方式與AEM as a Cloud Service環境互動
  3. 外部應用程式會從安全位置讀取服務證明資料
  4. 外部應用程式會使用服務憑證中的資訊來建構JWT權杖
  5. JWT權杖會傳送至Adobe IMS以交換存取權杖
  6. Adobe IMS傳回可用來存取AEM as a Cloud Service的存取權杖
    • 存取權杖無法變更到期時間。
  7. 外部應用程式會向AEM as a Cloud Service發出HTTP請求,將存取權杖作為持有人權杖新增到HTTP請求的授權標頭
  8. AEM as a Cloud Service會收到HTTP要求、驗證要求,並執行HTTP要求所要求的工作,然後將HTTP回應傳回至外部應用程式

外部應用程式的更新

若要使用服務憑證存取AEM as a Cloud Service,外部應用程式必須透過三種方式更新:

  1. 讀取服務認證
  • 為簡化起見,服務憑證會從下載的JSON檔案中讀取,但在實際使用情況下,服務憑證必須根據您組織的安全方針安全儲存
  1. 從服務憑證產生JWT
  2. 交換JWT以取得存取權杖
  • 當存在服務憑證時,外部應用程式在存取AEM as a Cloud Service時會使用此存取權杖,而不是本機開發存取權杖

在本教學課程中,Adobe的@adobe/jwt-auth npm模組是用來在單一函式呼叫中,(1)從服務認證產生JWT,以及(2)交換它以取得存取權杖。 如果您的應用程式不是以JavaScript為基礎,請檢閱其他語言的範常式式碼,瞭解如何從服務憑證建立JWT,並與Adobe IMS交換存取權杖。

讀取服務認證

請檢閱getCommandLineParams(),瞭解如何使用讀取本機開發存取權杖JSON時所使用的相同程式碼來讀取服務認證JSON檔案。

function getCommandLineParams() {
    ...

    // Read in the credentials from the provided JSON file
    // Since both the Local Development Access Token and Service Credentials files are JSON, this same approach can be re-used
    if (parameters.file) {
        parameters.developerConsoleCredentials = JSON.parse(fs.readFileSync(parameters.file));
    }

    ...
    return parameters;
}

建立JWT並交換存取權杖

讀取服務認證後,即會使用它們產生JWT,然後與Adobe IMS API交換存取權杖。 接著,您就可以使用此存取權杖來存取AEM as a Cloud Service。

此範例應用程式是以Node.js為基礎,因此最好使用@adobe/jwt-auth npm模組來促進(1) JWT的產生和(20)與Adobe IMS的交換。 如果您的應用程式是使用其他語言開發的,請檢閱適當的程式碼範例,瞭解如何使用其他程式語言建構向Adobe IMS傳送的HTTP要求。

  1. 更新getAccessToken(..)以檢查JSON檔案內容,並判斷其是否代表本機開發存取權杖或服務認證。 這可透過檢查.accessToken屬性的存在來輕鬆達成,該屬性僅存在於本機開發存取權杖JSON中。

    如果提供服務認證,應用程式會產生JWT並與Adobe IMS交換存取權杖。 使用@adobe/jwt-authauth(...)函式,該函式會產生JWT並在單一函式呼叫中將它交換為存取權杖。 auth(..)方法的引數是JSON物件,包含服務認證JSON提供的特定資訊,如下列程式碼所述。

 async function getAccessToken(developerConsoleCredentials) {

     if (developerConsoleCredentials.accessToken) {
         // This is a Local Development access token
         return developerConsoleCredentials.accessToken;
     } else {
         // This is the Service Credentials JSON object that must be exchanged with Adobe IMS for an access token
         let serviceCredentials = developerConsoleCredentials.integration;

         // Use the @adobe/jwt-auth library to pass the service credentials generated a JWT and exchange that with Adobe IMS for an access token.
         // If other programming languages are used, please see these code samples: https://www.adobe.io/authentication/auth-methods.html#!AdobeDocs/adobeio-auth/master/JWT/samples/samples.md
         let { access_token } = await auth({
             clientId: serviceCredentials.technicalAccount.clientId, // Client Id
             technicalAccountId: serviceCredentials.id,              // Technical Account Id
             orgId: serviceCredentials.org,                          // Adobe IMS Org Id
             clientSecret: serviceCredentials.technicalAccount.clientSecret, // Client Secret
             privateKey: serviceCredentials.privateKey,              // Private Key to sign the JWT
             metaScopes: serviceCredentials.metascopes.split(','),   // Meta Scopes defining level of access the access token should provide
             ims: `https://${serviceCredentials.imsEndpoint}`,       // IMS endpoint used to obtain the access token from
         });

         return access_token;
     }
 }
現在,根據哪個JSON檔案(本機開發存取權杖JSON或服務認證JSON)是透過'file'命令列引數傳入,應用程式將會衍生存取權杖。

請記住,雖然服務認證每365天過期一次,但JWT和對應的存取權杖經常過期,而且需要在過期前重新整理。 使用[Adobe IMS提供的](https://www.adobe.io/authentication/auth-methods.html#!AdobeDocs/adobeio-auth/master/OAuth/OAuth.md#access-tokens)的'refresh_token'即可完成這項作業。
  1. 完成這些變更後,服務認證JSON已從AEM Developer Console下載,為簡化起見,在與index.js相同的資料夾中儲存為service_token.json。 現在,讓我們執行將命令列引數file取代為service_token.json的應用程式,並將propertyValue更新為新值,以便在AEM中顯示效果。

    code language-shell
    $ node index.js \
        aem=https://author-p1234-e5678.adobeaemcloud.com \
        folder=/wknd-shared/en/adventures/napa-wine-tasting \
        propertyName=metadata/dc:rights \
        propertyValue="WKND Restricted Use" \
        file=service_token.json
    

    輸出到終端機的方式如下:

    code language-shell
    200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting.json
    403 - Forbidden @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_277654931.jpg.json
    403 - Forbidden @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_239751461.jpg.json
    403 - Forbidden @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_280313729.jpg.json
    403 - Forbidden @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_286664352.jpg.json
    

    403 - Forbidden ​行表示對AEM as a Cloud Service的HTTP API呼叫發生錯誤。 嘗試更新資產的中繼資料時,會發生這403個禁止錯誤。

    原因在於服務認證衍生的存取權杖會使用自動建立的技術帳戶AEM使用者(預設情況下只有讀取存取權)來驗證AEM的要求。 若要提供應用程式對AEM的寫入存取權,與存取權杖相關聯的技術帳戶AEM使用者必須在AEM中取得許可權。

在AEM中設定存取權

服務認證衍生的存取權杖使用的技術帳戶AEM User擁有​ 貢獻者 AEM使用者群組的成員資格。

服務認證 — 技術帳戶AEM使用者

一旦技術帳戶AEM使用者存在於AEM中(具有存取權杖的第一個HTTP請求之後),就可以像管理其他AEM使用者一樣管理此AEM使用者的許可權。

  1. 首先,開啟從AEM Developer Console下載的服務認證JSON以找出技術帳戶的AEM登入名稱,然後找出應類似於12345678-abcd-9000-efgh-0987654321c@techacct.adobe.comintegration.email值。
  2. 以AEM管理員身分登入對應AEM環境的作者服務
  3. 瀏覽至​ 工具 > 安全性 > 使用者
  4. 找出在步驟1中識別為​ 登入名稱 ​的AEM使用者,並開啟其​ 屬性
  5. 導覽至「群組」標籤,然後新增​ DAM使用者 ​群組(他們可做為資產的寫入存取權)
    • 檢視AEM提供的使用者群組清單,以將服務使用者新增至以獲得最佳許可權。 如果AEM提供的使用者群組都不夠用,請建立您自己的使用者群組,然後新增適當的許可權。
  6. 點選​ 儲存並關閉

在AEM允許技術帳戶擁有資產的寫入許可權的情況下,請重新執行應用程式:

$ node index.js \
    aem=https://author-p1234-e5678.adobeaemcloud.com \
    folder=/wknd-shared/en/adventures/napa-wine-tasting \
    propertyName=metadata/dc:rights \
    propertyValue="WKND Restricted Use" \
    file=service_token.json

輸出到終端機的方式如下:

200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting.json
200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_277654931.jpg.json
200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_286664352.jpg.json
200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_239751461.jpg.json
200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd-shared/en/adventures/napa-wine-tasting/AdobeStock_280313729.jpg.json

驗證變更

  1. 登入已更新的AEM as a Cloud Service環境(使用aem命令列引數中提供的相同主機名稱)
  2. 導覽至​ Assets > 檔案
  3. 瀏覽至folder命令列引數指定的資產資料夾,例如​ WKND > 英文 > 冒險 > Napa品酒會
  4. 開啟資料夾中任何資產的​ 屬性
  5. 導覽至​ 進階 ​標籤
  6. 檢閱更新屬性的值,例如​ Copyright,其對應到更新的metadata/dc:rights JCR屬性,現在會反映propertyValue引數中提供的值,例如​ WKND Restricted Use

WKND限制的使用中繼資料更新

恭喜!

現在,我們已使用本機開發存取權杖和生產就緒服務對服務存取權杖,以程式設計方式存取AEM as a Cloud Service!

recommendation-more-help
e25b6834-e87f-4ff3-ba56-4cd16cdfdec4