管理钥匙-删除钥匙

请求参数

Header 参数

x-requestId

string

可选

设备 OEM 服务器和车辆 OEM 服务器的所有请求都应具有 HTTP 标头“x-requestId”。该值应为包含连字符的长度为 36 的 UUID。

x-device-oemId

string

可选

设备 OEM 服务器的所有请求都应具有 HTTP 标头“x-device-oemId”。值是设备 OEM 的名称。

Body 参数application/json

keyID

string

唯一标识

必需

钥匙ID

action

string

钥匙管理事件类型

必需

TERMINATE-终止
SUSPEND-暂停
RESUME-恢复

deviceRemoteTerminationRequest

object

可选

由所有者设备提供：当共享密钥从所有者设备上被终止时，用于终止远程密钥的远程终止请求。 DigitalKeyx签署。SK在第14节中定义

version

string

指定的算法的标识符。示例“ECIES_v1”

可选

ephemeralPublicKey

string

临时公钥

可选

十六进制编码的发件人的临时公钥。为单个消息生成的临时密钥对。
发送方公钥的编码格式：concat(0x04, x, y)（对于基于命名曲线 secp256r1 1.2.840.10045.3.1.7 生成的密钥，总共 65 个字节）

publicKeyHash

string

公钥指纹

可选

十六进制编码的收件人的钥匙协议公钥指纹。
指纹生成算法：sha256Hash(toUncompressedRawECPublicKeyFormat(recipientKAPublicKey)
ECIES_v1 钥匙协议中使用的接收系统的未压缩钥匙协议公钥 (concat(0x04, x, y)) 的 SHA-256 哈希

data

string

加密数据

可选

加密数据的Base64编码。

data=base64Encode(encrypt(unencryptedData, symmetricEncryptionParams))

serverRemoteTerminationRequest

string

可选

由KTS提供：当车辆OEM服务器上的所有者密钥或共享密钥被终止时，用于终止远程密钥的远程终止请求。

由第14节定义的vehicle - oem . sig . sk签署。

vehicleOEMProprietaryData

string

必需

设备端提供：当设备上的所有者或共享密钥被终止(本地或远程终止)时，包含车辆OEM专有数据的数字密钥私有邮箱的分段。

示例

{
    "keyID": "4938205039594",
    "action": "TERMINATE",
    "deviceRemoteTerminationRequest": {
        "version": "ECIES_v1",
        "ephemeralPublicKey": "16eb03825f2d97827d91806d630bc4adff44686587ffd58d32f4522ada80cc01126f1a6186b2a00893679e1abf8172fd41f0c0c1bdda3b0046131123616dc0729e",
        "publicKeyHash": "677a1aa052d7caef29d6e3bbc95bf11d43e3609579966168d7d533fd76a02e19",
        "data": "kE8/Rs9sNo4olc6s3Qej7mXhAtDPcp...1Bm/r7bKNX6m365vnIDEDc"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/keyApi/v1/manageKey' \
--header 'Content-Type: application/json' \
--data-raw '{
    "keyID": "4938205039594",
    "action": "TERMINATE",
    "deviceRemoteTerminationRequest": {
        "version": "ECIES_v1",
        "ephemeralPublicKey": "16eb03825f2d97827d91806d630bc4adff44686587ffd58d32f4522ada80cc01126f1a6186b2a00893679e1abf8172fd41f0c0c1bdda3b0046131123616dc0729e",
        "publicKeyHash": "677a1aa052d7caef29d6e3bbc95bf11d43e3609579966168d7d533fd76a02e19",
        "data": "kE8/Rs9sNo4olc6s3Qej7mXhAtDPcp...1Bm/r7bKNX6m365vnIDEDc"
    }
}'

返回响应

🟢201成功

application/json

Body

responseHeader

object

公共响应标头

必需

statusCode

string

状态码

必需

encryptedData

object

加密数据

必需

version

string

版本

必需

ephemeralPublicKey

string

十六进制编码的发件人的临时公钥。

必需

publicKeyHash

string

十六进制编码的收件人的钥匙协议公钥指纹。

必需

data

string

加密数据的Base64编码。

必需

示例

拥有者删除共享钥匙朋友删除自己的钥匙

{
    "responseHeader": {
        "statusCode": "200"
    },
    "encryptedData": {
        "version": "ECIES_v1",
        "ephemeralPublicKey": "098234098234750893476372832742373468923482357508932832742373468923482347637283274237346892348235",
        "publicKeyHash": "50982347502373468923482385098234750237346892394346892348234763728327",
        "data": "ydST1ZG5Q3cflzfM1qjjwpmOmWQHta...SBBiIAGK3PUbdE2IF/MmPefY9b"
    }
}