停用 Edge 的基本驗證功能

Edge for Private Cloud 4.18.01 版

在 Edge 上啟用 SAML 後,即可停用基本驗證。不過,停用基本驗證前,請先完成下列事項:

  • 請確認您已將所有 Edge 使用者 (包括系統管理員) 新增至 SAML IDP。
  • 請務必在 Edge UI 和 Edge Management API 上,徹底測試 SAML 驗證。
  • 如果您也使用 API BaaS,請在 API BaaS 上設定及測試 SAML。請參閱「為 API BaaS 啟用 SAML」。
  • 如果您使用的是開發人員服務入口網站,請在入口網站上設定及測試 SAML,確保入口網站可以連線至 Edge。請參閱「設定開發人員服務入口網站,使用 SAML 與 Edge 通訊」。

查看目前的安全性設定檔

您可以查看 Edge 安全性設定檔,判斷目前的設定是否已啟用基本驗證和 SAML。在 Edge 管理伺服器上使用下列 Edge Management API 呼叫,查看 Edge 目前使用的安全性設定檔:

> curl -H "accept:application/xml" http://localhost:8080/v1/securityprofile -u sysAdminEmail:pWord

如果您尚未設定 SAML,回應會如下所示,表示已啟用基本驗證:

<SecurityProfile enabled="true" name="securityprofile">
    <UserAccessControl enabled="true">
    </UserAccessControl>
</SecurityProfile>

如果您已啟用 SAML,輸出內容中會顯示 <ssoserver> 標記:

<SecurityProfile enabled="true" name="securityprofile">
    <UserAccessControl enabled="true">
        <SSOServer>
            <BasicAuthEnabled>true</BasicAuthEnabled>
            <PublicKeyEndPoint>/token_key</PublicKeyEndPoint>
            <ServerUrl>http://35.197.37.220:9099</ServerUrl>
        </SSOServer>
    </UserAccessControl>
</SecurityProfile>

請注意,啟用 SAML 的版本也會顯示 <BasicAuthEnabled>true</BasicAuthEnabled>,表示基本驗證仍處於啟用狀態。

停用基本驗證

在 Edge 管理伺服器上使用下列 Edge Management API 呼叫,停用基本驗證。請注意,您要傳遞的酬載是上一節傳回的 XML 物件。唯一的差別在於您將 <BasicAuthEnabled>false</BasicAuthEnabled> 設為 false:

> curl -H "Content-Type: application/xml"
http://localhost:8080/v1/securityprofile  -u sysAdminEmail:pWord -d
 '<SecurityProfile enabled="true" name="securityprofile">
  <UserAccessControl enabled="true">
    <SSOServer>
      <BasicAuthEnabled>false</BasicAuthEnabled>
      <PublicKeyEndPoint>/token_key</PublicKeyEndPoint>
      <ServerUrl>http://35.197.37.220:9099</ServerUrl>
  </SSOServer>
 </UserAccessControl>
</SecurityProfile>'

停用基本驗證後,任何傳遞基本驗證憑證的 Edge 管理 API 呼叫都會傳回下列錯誤:

<Error>
    <Code>security.SecurityProfileBasicAuthDisabled</Code>
    <Message>Basic Authentication scheme not allowed</Message>
    <Contexts/>
</Error>

重新啟用基本驗證

如果因故必須重新啟用基本驗證,請務必執行下列步驟:

注意:重新啟用基本驗證時,您必須暫時停用 Edge 上的「所有」驗證機制,包括 SAML。

  1. 登入任何 Edge ZooKeeper 節點。
  2. 執行下列 Bash 指令碼,關閉所有安全性功能:
    注意:這個步驟會停用 Edge 上的所有驗證功能,包括 SAML。

    #! /bin/bash
    /opt/apigee/apigee-zookeeper/bin/zkCli.sh -server localhost:2181 <<EOF
    set /system/securityprofile <SecurityProfile></SecurityProfile>
    quit
    EOF

    您會看到以下形式的輸出內容:
    Connecting to localhost:2181
    Welcome to ZooKeeper!
    JLine support is enabled
    WATCHER::

    WatchedEvent state:SyncConnected type:None path:null
    [zk: localhost:2181(CONNECTED) 0] set /system/securityprofile <SecurityProfile></SecurityProfile>
    cZxid = 0x89
    ...
    [zk: localhost:2181(CONNECTED) 1] quit
    Quitting…
  3. 重新啟用基本驗證和 SAML 驗證:

    > curl -H "Content-Type: application/xml"
    http://localhost:8080/v1/securityprofile -u sysAdminEmail:pWord -d
    '<SecurityProfile enabled="true" name="securityprofile">

    <UserAccessControl enabled="true">
    <SSOServer>
    <BasicAuthEnabled>true</BasicAuthEnabled>
    <PublicKeyEndPoint>/token_key</PublicKeyEndPoint>
    <ServerUrl>http://35.197.37.220:9099</ServerUrl>
    </SSOServer>
    </UserAccessControl>
    </SecurityProfile>'

    現在可以再次使用基本驗證。