package pkcs11

  1. Overview
  2. Docs
Bindings to the PKCS#11 cryptographic API

Install 

dune-project
 Dependency

github.com Readme Changelog BSD-2-Clause License Edit opam file Versions (13)

Authors

  1. E
    Etienne Millon <etienne@cryptosense.com>

Maintainers

  1. E
    Etienne Millon <etienne@cryptosense.com>

Sources

pkcs11-0.14.0.tbz
sha256=56145aabfe82a55851da4e5d131cc5d2e87ac8ca6955e1b16b303a32d3fa4bcd
md5=d6d18b0852925320e5b0ceaf1c433c5a

doc/pkcs11/P11_mechanism/index.html

Module P11_mechanism

type t =
  1. | CKM_SHA_1
  2. | CKM_SHA224
  3. | CKM_SHA256
  4. | CKM_SHA384
  5. | CKM_SHA512
  6. | CKM_MD5
  7. | CKM_RSA_PKCS_KEY_PAIR_GEN
  8. | CKM_RSA_X9_31_KEY_PAIR_GEN
  9. | CKM_RSA_PKCS
  10. | CKM_RSA_PKCS_OAEP of P11_rsa_pkcs_oaep_params.t
  11. | CKM_RSA_X_509
  12. | CKM_RSA_PKCS_PSS of P11_rsa_pkcs_pss_params.t
  13. | CKM_SHA1_RSA_PKCS
  14. | CKM_SHA224_RSA_PKCS
  15. | CKM_SHA256_RSA_PKCS
  16. | CKM_SHA384_RSA_PKCS
  17. | CKM_SHA512_RSA_PKCS
  18. | CKM_SHA1_RSA_PKCS_PSS of P11_rsa_pkcs_pss_params.t
  19. | CKM_SHA224_RSA_PKCS_PSS of P11_rsa_pkcs_pss_params.t
  20. | CKM_SHA256_RSA_PKCS_PSS of P11_rsa_pkcs_pss_params.t
  21. | CKM_SHA384_RSA_PKCS_PSS of P11_rsa_pkcs_pss_params.t
  22. | CKM_SHA512_RSA_PKCS_PSS of P11_rsa_pkcs_pss_params.t
  23. | CKM_AES_KEY_GEN
  24. | CKM_AES_ECB
  25. | CKM_AES_CBC of P11_hex_data.t
  26. | CKM_AES_CBC_PAD of P11_hex_data.t
  27. | CKM_AES_MAC
  28. | CKM_AES_MAC_GENERAL of P11_ulong.t
  29. | CKM_AES_ECB_ENCRYPT_DATA of P11_hex_data.t
  30. | CKM_AES_CBC_ENCRYPT_DATA of P11_aes_cbc_encrypt_data_params.t
  31. | CKM_DES_KEY_GEN
  32. | CKM_DES_ECB
  33. | CKM_DES_CBC of P11_hex_data.t
  34. | CKM_DES_CBC_PAD of P11_hex_data.t
  35. | CKM_DES_MAC
  36. | CKM_DES_MAC_GENERAL of P11_ulong.t
  37. | CKM_DES_ECB_ENCRYPT_DATA of P11_hex_data.t
  38. | CKM_DES_CBC_ENCRYPT_DATA of P11_des_cbc_encrypt_data_params.t
  39. | CKM_DES3_KEY_GEN
  40. | CKM_DES3_ECB
  41. | CKM_DES3_CBC of P11_hex_data.t
  42. | CKM_DES3_CBC_PAD of P11_hex_data.t
  43. | CKM_DES3_MAC
  44. | CKM_DES3_MAC_GENERAL of P11_ulong.t
  45. | CKM_DES3_ECB_ENCRYPT_DATA of P11_hex_data.t
  46. | CKM_DES3_CBC_ENCRYPT_DATA of P11_des_cbc_encrypt_data_params.t
  47. | CKM_CONCATENATE_BASE_AND_DATA of P11_hex_data.t
  48. | CKM_CONCATENATE_DATA_AND_BASE of P11_hex_data.t
  49. | CKM_XOR_BASE_AND_DATA of P11_hex_data.t
  50. | CKM_EXTRACT_KEY_FROM_KEY of P11_ulong.t
  51. | CKM_CONCATENATE_BASE_AND_KEY of P11_object_handle.t
  52. | CKM_EC_KEY_PAIR_GEN
  53. | CKM_ECDSA
  54. | CKM_ECDSA_SHA1
  55. | CKM_ECDSA_SHA224
  56. | CKM_ECDSA_SHA256
  57. | CKM_ECDSA_SHA384
  58. | CKM_ECDSA_SHA512
  59. | CKM_ECDH1_DERIVE of P11_ecdh1_derive_params.t
  60. | CKM_ECDH1_COFACTOR_DERIVE of P11_ecdh1_derive_params.t
  61. | CKM_ECMQV_DERIVE of P11_ecmqv_derive_params.t
  62. | CKM_PKCS5_PBKD2 of P11_pkcs5_pbkd2_data_params.t
  63. | CKM_DSA_KEY_PAIR_GEN
  64. | CKM_DSA_SHA1
  65. | CKM_DSA_SHA224
  66. | CKM_DSA_SHA256
  67. | CKM_DSA_SHA384
  68. | CKM_DSA_SHA512
  69. | CKM_AES_CTR of P11_aes_ctr_params.t
  70. | CKM_AES_GCM of P11_gcm_params.t
  71. | CKM_SHA_1_HMAC
  72. | CKM_SHA224_HMAC
  73. | CKM_SHA256_HMAC
  74. | CKM_SHA384_HMAC
  75. | CKM_SHA512_HMAC
  76. | CKM_GENERIC_SECRET_KEY_GEN
  77. | CKM_AES_KEY_WRAP of P11_aes_key_wrap_params.t
  78. | CKM_CS_UNKNOWN of P11_ulong.t
val equal : t -> t -> Ppx_deriving_runtime.bool
val compare : t -> t -> Ppx_deriving_runtime.int
val to_yojson : t -> Yojson.Safe.t
val of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_or
val mechanism_type : t -> P11_mechanism_type.t
val to_string : t -> string

to_string is defined as fun x -> Mechanism_type.to_string (mechanism_type x)

type kind =
  1. | Encrypt
  2. | Sign
  3. | SignRecover
  4. | Wrap
  5. | Derive
  6. | Digest
  7. | Generate
  8. | Symmetric
  9. | Asymmetric
  10. | DES
  11. | DES3
  12. | AES
  13. | RSA
  14. | DH
  15. | EC

Kinds are "tags" on mechanisms which describe how they can be used.

val kinds : t -> kind list

kinds mechanism returns the tags for the mechanism mechanism.

val is : kind list -> t -> bool

is kinds t checks that the mechanism t has all the tags in the list kinds.

val key_type : t -> P11_key_type.t option

key_type t returns the type of keys associated to the mechanism t.