diff options
| -rw-r--r-- | doc/manual/pkcs11.rst | 2 | ||||
| -rw-r--r-- | doc/manual/tls.rst | 18 | ||||
| -rw-r--r-- | doc/manual/tpm.rst | 12 | ||||
| -rw-r--r-- | doc/manual/x509.rst | 2 |
4 files changed, 17 insertions, 17 deletions
diff --git a/doc/manual/pkcs11.rst b/doc/manual/pkcs11.rst index c6b7ec07d..6e2827b16 100644 --- a/doc/manual/pkcs11.rst +++ b/doc/manual/pkcs11.rst @@ -445,7 +445,7 @@ Attributes can be set in an :cpp:class:`AttributeContainer` by various ``add_`` Add a bool attribute (e.g. :c:macro:`CKA_SENSITIVE` / :cpp:enumerator:`AttributeType::Sensitive`). - .. cpp:function:: template<typename T> void AttributeContainer::add_numeric(AttributeType attribute, T value) + .. cpp:function:: template<typename T> void AttributeContainer::add_numeric(AttributeType attribute, T value) Add a numeric attribute (e.g. :c:macro:`CKA_MODULUS_BITS` / :cpp:enumerator:`AttributeType::ModulusBits`). diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index 310beaee1..c9f404afb 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -866,7 +866,7 @@ policy settings from a file. protections against the Lucky13 attack are somewhat more effective for SHA-256 than SHA-384. -.. cpp:function:: std::vector<std::string> allowed_key_exchange_methods() const + .. cpp:function:: std::vector<std::string> allowed_key_exchange_methods() const Returns the list of key exchange methods we are willing to use, in order of preference. @@ -1054,37 +1054,37 @@ policy settings from a file. Default: 2048 bits -.. cpp:function:: bool allow_tls10() const + .. cpp:function:: bool allow_tls10() const Return true from here to allow TLS v1.0. Since 2.8.0, returns ``false`` by default. -.. cpp:function:: bool allow_tls11() const + .. cpp:function:: bool allow_tls11() const Return true from here to allow TLS v1.1. Since 2.8.0, returns ``false`` by default. -.. cpp:function:: bool allow_tls12() const + .. cpp:function:: bool allow_tls12() const Return true from here to allow TLS v1.2. Returns ``true`` by default. -.. cpp:function:: size_t minimum_rsa_bits() const + .. cpp:function:: size_t minimum_rsa_bits() const Minimum accepted RSA key size. Default 2048 bits. -.. cpp:function:: size_t minimum_dsa_group_size() const + .. cpp:function:: size_t minimum_dsa_group_size() const Minimum accepted DSA key size. Default 2048 bits. -.. cpp:function:: size_t minimum_ecdsa_group_size() const + .. cpp:function:: size_t minimum_ecdsa_group_size() const Minimum size for ECDSA keys (256 bits). -.. cpp:function:: size_t minimum_ecdh_group_size() const + .. cpp:function:: size_t minimum_ecdh_group_size() const Minimum size for ECDH keys (255 bits). -.. cpp:function:: void check_peer_key_acceptable(const Public_Key& public_key) const + .. cpp:function:: void check_peer_key_acceptable(const Public_Key& public_key) const Allows the policy to examine peer public keys. Throw an exception if the key should be rejected. Default implementation checks diff --git a/doc/manual/tpm.rst b/doc/manual/tpm.rst index ddf615d03..7598c4bd8 100644 --- a/doc/manual/tpm.rst +++ b/doc/manual/tpm.rst @@ -61,7 +61,7 @@ match the TPM's behavior. The key_password is the password to the TPM key ? - .. cpp:function:: std::string register_key(TPM_Storage_Type storage_type) + .. cpp:function:: std::string register_key(TPM_Storage_Type storage_type) Registers a key with the TPM. The storage_type can be either `TPM_Storage_Type::User` or `TPM_Storage_Type::System`. If System, the @@ -79,27 +79,27 @@ match the TPM's behavior. Returns a UUID which can be passed back to constructor below. - .. cpp:function:: TPM_PrivateKey(TPM_Context& ctx, const std::string& uuid, \ + .. cpp:function:: TPM_PrivateKey(TPM_Context& ctx, const std::string& uuid, \ TPM_Storage_Type storage_type) Load a registered key. The UUID was returned by the ``register_key`` function. - .. cpp:function:: std::vector<uint8_t> export_blob() const + .. cpp:function:: std::vector<uint8_t> export_blob() const Export the key as an encrypted blob. This blob can later be presented back to the same TPM to load the key. - .. cpp:function:: TPM_PrivateKey(TPM_Context& ctx, const std::vector<uint8_t>& blob) + .. cpp:function:: TPM_PrivateKey(TPM_Context& ctx, const std::vector<uint8_t>& blob) Load a TPM key previously exported as a blob with ``export_blob``. - .. cpp:function:: std::unique_ptr<Public_Key> public_key() const + .. cpp:function:: std::unique_ptr<Public_Key> public_key() const Return the public key associated with this TPM private key. TPM does not store public keys, nor does it support signature verification. - .. cpp:function:: TSS_HKEY handle() const + .. cpp:function:: TSS_HKEY handle() const Returns the bare TSS key handle. Use if you need to call the raw TSS API. diff --git a/doc/manual/x509.rst b/doc/manual/x509.rst index 08b6b66a8..122a85b03 100644 --- a/doc/manual/x509.rst +++ b/doc/manual/x509.rst @@ -498,7 +498,7 @@ The result of the validation is returned as a class: If the validation was successful, returns the certificate which is acting as the trust root for *end_cert*. - .. cpp:function:: const std::vector<X509_Certificate>& cert_path() const + .. cpp:function:: const std::vector<X509_Certificate>& cert_path() const Returns the full certificate path starting with the end entity certificate and ending in the trust root. |