HMAC SHA256 - Create a new key share (before secret share import)

GET 
/hmac-sha256/create

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: KeysManager

Setup a new HMAC-SHA256 key share (before importing the full HMAC key) for the authenticated user.

All parties must call this function before calling import/import-secret-share. The returned keygen_id must be sent through an authenticated communication channel to all other devices we wish to share the HMAC key with. Once we have the keygen_id-s of all parties, then /hmac-sha256/import/import-secret-share can be called with the same key_id as was given here.

Unlike ECDSA and similar algorithms, HMAC does not involve a 'keygen' process. Instead, the user must import a pre-split secret share to these parties.

Request

Query Parameters

key_name stringnull

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.

Responses

200

application/json

Schema

Schema

key_idstringrequired
key_namestring | nullnullable
keygen_idstringrequired

Example (from schema)

{
  "key_id": "string",
  "keygen_id": "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, failed_to_import_key_share, frozen_key_share, 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"
}