管理存取金鑰

存取金鑰是一種憑證,您必須使用它來設定代理程式,才能成功將資料轉發至 IBM Cloud 中的 Workload Protection 實例。

使用控制台管理存取金鑰

您可以透過 IBM Cloud 控制台,檢視、建立、停用、啟用及刪除 Workload Protection 實例的存取金鑰。

若要透過控制台管理存取金鑰,請執行以下步驟:

  1. IBM Cloud 控制台 中,點擊 導覽選單 圖示 導覽選單圖示 > 安全性 > 合規性
  2. 點擊您的「Workload Protection」執行個體的名稱。
  3. 從「動作」選單中,選擇「管理金鑰」。
  4. 點擊您的儀表板,即可檢視、建立、停用、啟用或刪除存取金鑰。

您也可以將存取金鑰隱藏起來,讓非管理員無法看到。 如需更多資訊,請參閱「非管理員使用者」。

使用 CLI 取得存取金鑰

若要透過 CLI 取得 Workload Protection 實例的存取金鑰,請完成以下步驟:

  1. 安裝 IBM Cloud CLI

  2. Workload Protection 請執行 ibmcloud login 指令:

    ibmcloud login
    
  3. 執行 ibmcloud target 指令:

    ibmcloud target -g <resource_group>
    

    其中 <resource_group> 為資源群組的名稱。 依預設,會設定 default 資源群組。

  4. 執行 ibmcloud resource service-instances 指令:

    ibmcloud resource service-instances
    
  5. 執行 ibmcloud resource service-keys 指令:

    ibmcloud resource service-keys --instance-name <instance_name> --output JSON
    

    其中 <instance_name> 是指您在上一步驟中取得的實例名稱。

    此指令的輸出內容包含「Sysdig Access Key」欄位,其中載有該執行個體的存取金鑰。

您也可以透過 API 或控制台來建立、刪除、啟用或停用存取金鑰。 若要查看操作步驟,請切換至 API 說明,或前往「使用控制台管理存取金鑰」。

透過 API 取得存取金鑰

您可以透過 CLI 或控制台取得存取金鑰。 如需查看操作步驟,請切換至 CLI 或 UI 操作說明。 您也可以使用 API 擷取所有可用的存取金鑰。 如需更多資訊,請參閱「使用 API 檢視可用的存取金鑰」。

使用 API 建立存取金鑰

如果存取金鑰遭到洩露,或者您的政策規定需在若干天後更新存取金鑰,您可以產生新的存取金鑰並停用舊的存取金鑰。

若要為 Workload Protection 實例建立新的存取金鑰,請完成以下步驟:

  1. 請從 Workload Protection 使用者介面中複製 API 憑證。 如需更多資訊,請參閱「取得 Sysdig API 憑證」。

  2. 對該端點發出 curl POST 請求,以產生新的存取金鑰:

    curl -X POST -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys
    

    其中:

    • ENDPOINT 是該實例所在區域的 URL。 如需相關資訊,請參閱 端點
    • SYSDIG_API_TOKEN 這是您在步驟 1 中取得的 API 憑證。
    • GUID 是與存取金鑰相關聯之實例的 GUID。

    例如:

    curl -X POST -H 'Authorization: Bearer xxxxxxx' -H 'IBMInstanceID: 12345678-1234-1234-1234-123456789012' https://us-east.security-compliance-secure.cloud.ibm.com/api/customer/accessKeys
    

    輸出會在回應中提供生成的存取金鑰:

    {
        "customerAccessKey": {
            "enabled": true,
            "accessKey": "12345678-1234-1234-1234-123456789012",
            "dateCreated": 1573852152224,
            "dateDisabled": null,
            "limit": null,
            "reservation": null,
            "teamId": null
        }
    }
    

    現在您可以使用存取金鑰來設定代理程式。

使用 API 停用存取金鑰

若要停用 Workload Protection 實例的現有存取金鑰,請依照以下步驟操作:

  1. 請從 Workload Protection 使用者介面中複製 API 憑證。 如需更多資訊,請參閱「取得 Sysdig API 憑證」。

  2. 對該端點發出 curl POST 請求,以停用存取金鑰:

    curl -X POST -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY/disable
    

    其中:

    • ENDPOINT 是該實例所在區域的 URL。
    • SYSDIG_API_TOKEN 這是您在步驟 1 中取得的 API 憑證。
    • ACCESS_KEY 是您要停用的存取金鑰。
    • GUID 是與存取金鑰相關聯之實例的 GUID。

    停用存取金鑰後,與該存取金鑰連結的代理程式將立即被阻止向此 Workload Protection 實例傳送指標。

    例如:

    curl -X POST -H 'Authorization: Bearer xxxxxxx' -H 'IBMInstanceID: 12345678-1234-1234-1234-123456789012' https://us-east.security-compliance-secure.cloud.ibm.com/api/customer/accessKeys/b302311f-aa1c-4930-8726-59fb4ba0fe84/disable
    

    輸出結果會在回應中提供無障礙存取鍵:

    {
        "customerAccessKey": {
            "enabled": false,
            "accessKey": "12345678-1234-1234-1234-123456789012",
            "dateCreated": 1573852152224,
            "dateDisabled": 1683550789329,
            "limit": null,
            "reservation": null,
            "teamId": null
        }
    }
    

使用 API 啟用存取金鑰

若要為 Workload Protection 實例啟用現有的存取金鑰,請完成以下步驟:

  1. 請從 Workload Protection 使用者介面中複製 API 憑證。 如需更多資訊,請參閱「取得 Sysdig API 憑證」。

  2. 對該端點發出 curl POST 請求,以啟用存取金鑰:

    curl -X POST -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY/enable
    

    其中:

    • ENDPOINT 是該實例所在區域的 URL。
    • SYSDIG_API_TOKEN 這是您在步驟 1 中取得的 API 憑證。
    • ACCESS_KEY 是您要啟用的存取金鑰。
    • GUID 是與存取金鑰相關聯之實例的 GUID。

啟用存取金鑰後,您必須手動重新啟動代理程式,因為若代理程式使用已停用的存取金鑰進行連線,該代理程式將會被終止。

使用 API 檢視可用的存取金鑰

若要檢視某個 Workload Protection 實例的所有存取金鑰,請執行以下步驟:

  1. 請從 Workload Protection 使用者介面中複製 API 憑證。 如需更多資訊,請參閱「取得 Sysdig API 憑證」。

  2. 對區域端點發出 curl GET 請求,以檢視存取金鑰:

    curl -X GET -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys
    

    其中:

    • ENDPOINT 是該實例所在區域的 URL。 如需相關資訊,請參閱 端點
    • SYSDIG_API_TOKEN 這是您在步驟 1 中取得的 API 憑證。
    • GUID 是與存取金鑰相關聯之實例的 GUID。

    輸出內容會列出存取金鑰清單,並標示其是否已啟用:

    {
        "customerAccessKeys": [
            {
                "enabled": true,
                "accessKey": "12345678-1234-1234-1234-123456789012",
                "dateCreated": 1541096409000,
                "dateDisabled": null,
                "limit": null,
                "reservation": null,
                "teamId": null
            },
            {
                "enabled": false,
                "accessKey": "87654321-1234-1234-1234-123456789012",
                "dateCreated": 1573849361000,
                "dateDisabled": 1573849367000,
                "limit": null,
                "reservation": null,
                "teamId": null
            }
        ]
    }
    

使用 API 刪除存取金鑰

若要刪除 Workload Protection 實例的存取金鑰,請依照以下步驟操作:

  1. 請從 Workload Protection 使用者介面中複製 API 憑證。 如需更多資訊,請參閱「取得 Sysdig API 憑證」。

  2. 針對區域端點發出 curl DELETE 請求,以刪除存取金鑰:

    curl -X DELETE -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY
    

    其中:

    • ENDPOINT 是該實例所在區域的 URL。
    • SYSDIG_API_TOKEN 這是您在步驟 1 中取得的 API 憑證。
    • GUID 是與存取金鑰相關聯之實例的 GUID。
    • ACCESS_KEY 是要刪除的存取金鑰。 您可以 檢視所有存取金鑰的清單,以取得存取金鑰值。