HMAC SHA256 - Sign a message using a key share

POST 
/hmac-sha256/sign

notice

This API endpoint part of the Exchange API Vault. Please contact the Sodot team for access.

authorization

This API endpoint requires an API Key with at least one of the following Roles: CryptoUser | KeysManager

Signs a message using HMAC-SHA256 with a specific key_id. The message, provided in the request, is signed using a secret share that was previously imported via the "/import-secret-share" endpoint.

The input message should be an array of bytes encoded as a hex string. The endpoint returns the signature as a bytes array encoded as a hex string.

Request

Header Parameters

AUTHORIZATION stringrequired

The AUTHORIZATION header must be set to the API Key of the user. The API Key is returned when a new user is created using the /admin/create-user endpoint.

application/json

Body

required

oneOf

MOD1

key_namestringrequired

MOD2

key_idKeyIdrequired
extra_datastring

Hex encoded extra data to be passed to the Rule Server. This data should be used to pass any additional information / external state to the Rule Server that is required to properly validate the signing request.

messagestringrequired

relay_address

object

An Optional relay address to use only for this specific MPC operation. If not provided, the default relay address will be used. The relay address should be in the format of host:port.

anyOf

HostAddress

string

room_uuidstringrequired

Responses

200

application/json

Schema

Schema

signaturestringrequired

Example (from schema)

{
  "signature": "string"
}

400

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [already_performed_keygen, api_key_not_found, bad_n_and_t_params, bad_request_params, batch_too_large, cant_delete_boot_admin, cluster_already_exists, cluster_not_found, executor_result, invalid_domain, key_not_found, key_operation_before_keygen, no_backup_private_key, no_backup_public_key, plaintext_backup_disabled, policy_already_exists, policy_in_use_by_keys, policy_in_use_by_users, policy_not_found, policy_validation_failed, room_creation_problem, rule_already_exists, rule_in_use, rule_not_found, rule_not_in_policy, user_already_exists, user_has_associated_keys, user_not_found, vertex_already_exists, vertex_not_found]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "already_performed_keygen"
}

401

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [access_denied, bad_key_permission]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "access_denied"
}

404

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [not_found]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "not_found"
}

500

application/json

Schema

Schema

err_msgstringrequired
err_typestringrequired

Possible values: [internal_problem]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "internal_problem"
}