travis: Bump tpm2-tss to 2.4.3
[strongswan.git] / src / libstrongswan / credentials / keys / private_key.h
index 79fc944..079c779 100644 (file)
@@ -1,6 +1,7 @@
 /*
 /*
+ * Copyright (C) 2017 Tobias Brunner
  * Copyright (C) 2007 Martin Willi
  * Copyright (C) 2007 Martin Willi
- * Hochschule fuer Technik Rapperswil
+ * HSR Hochschule fuer Technik Rapperswil
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -23,6 +24,7 @@
 
 typedef struct private_key_t private_key_t;
 
 
 typedef struct private_key_t private_key_t;
 
+#include <credentials/cred_encoding.h>
 #include <credentials/keys/public_key.h>
 
 /**
 #include <credentials/keys/public_key.h>
 
 /**
@@ -38,30 +40,46 @@ struct private_key_t {
        key_type_t (*get_type)(private_key_t *this);
 
        /**
        key_type_t (*get_type)(private_key_t *this);
 
        /**
+        * Get signature schemes supported by this key.
+        *
+        * This is useful for keys that only support certain hash algorithms or
+        * require specific parameters for RSA/PSS signatures.
+        *
+        * @note Implementing this method is optional. If multiple schemes are
+        * returned, they should be ordered by decreasing preference.
+        *
+        * @return                      enumerator over signature_params_t*
+        */
+       enumerator_t *(*supported_signature_schemes)(private_key_t *this);
+
+       /**
         * Create a signature over a chunk of data.
         *
         * @param scheme        signature scheme to use
         * Create a signature over a chunk of data.
         *
         * @param scheme        signature scheme to use
+        * @param params        optional parameters required by the specified scheme
         * @param data          chunk of data to sign
         * @param signature     where to allocate created signature
         * @return                      TRUE if signature created
         */
         * @param data          chunk of data to sign
         * @param signature     where to allocate created signature
         * @return                      TRUE if signature created
         */
-       bool (*sign)(private_key_t *this, signature_scheme_t scheme,
+       bool (*sign)(private_key_t *this, signature_scheme_t scheme, void *params,
                                 chunk_t data, chunk_t *signature);
        /**
         * Decrypt a chunk of data.
         *
                                 chunk_t data, chunk_t *signature);
        /**
         * Decrypt a chunk of data.
         *
+        * @param scheme        expected encryption scheme used
         * @param crypto        chunk containing encrypted data
         * @param plain         where to allocate decrypted data
         * @return                      TRUE if data decrypted and plaintext allocated
         */
         * @param crypto        chunk containing encrypted data
         * @param plain         where to allocate decrypted data
         * @return                      TRUE if data decrypted and plaintext allocated
         */
-       bool (*decrypt)(private_key_t *this, chunk_t crypto, chunk_t *plain);
+       bool (*decrypt)(private_key_t *this, encryption_scheme_t scheme,
+                                       chunk_t crypto, chunk_t *plain);
 
        /**
 
        /**
-        * Get the strength of the key in bytes.
+        * Get the strength of the key in bits.
         *
         *
-        * @return                      strength of the key in bytes
+        * @return                      strength of the key in bits
         */
         */
-       size_t (*get_keysize) (private_key_t *this);
+       int (*get_keysize) (private_key_t *this);
 
        /**
         * Get the public part from the private key.
 
        /**
         * Get the public part from the private key.
@@ -89,21 +107,29 @@ struct private_key_t {
        /**
         * Get the fingerprint of the key.
         *
        /**
         * Get the fingerprint of the key.
         *
-        * @param type          type of fingerprint, one of KEY_ID_*
+        * @param type          type of fingerprint, one of KEYID_*
         * @param fp            fingerprint, points to internal data
         * @return                      TRUE if fingerprint type supported
         */
         * @param fp            fingerprint, points to internal data
         * @return                      TRUE if fingerprint type supported
         */
-       bool (*get_fingerprint)(private_key_t *this, key_encoding_type_t type,
+       bool (*get_fingerprint)(private_key_t *this, cred_encoding_type_t type,
                                                        chunk_t *fp);
 
        /**
                                                        chunk_t *fp);
 
        /**
+        * Check if a key has a given fingerprint of any kind.
+        *
+        * @param fp            fingerprint to check
+        * @return                      TRUE if key has given fingerprint
+        */
+       bool (*has_fingerprint)(private_key_t *this, chunk_t fp);
+
+       /**
         * Get the key in an encoded form as a chunk.
         *
         * Get the key in an encoded form as a chunk.
         *
-        * @param type          type of the encoding, one of KEY_PRIV_*
+        * @param type          type of the encoding, one of PRIVKEY_*
         * @param encoding      encoding of the key, allocated
         * @return                      TRUE if encoding supported
         */
         * @param encoding      encoding of the key, allocated
         * @return                      TRUE if encoding supported
         */
-       bool (*get_encoding)(private_key_t *this, key_encoding_type_t type,
+       bool (*get_encoding)(private_key_t *this, cred_encoding_type_t type,
                                                 chunk_t *encoding);
 
        /**
                                                 chunk_t *encoding);
 
        /**
@@ -120,21 +146,30 @@ struct private_key_t {
 };
 
 /**
 };
 
 /**
- * Generic private key equals() implementation, usable by implementors.
+ * Generic private key equals() implementation, usable by implementers.
  *
  *
- * @param this                 first key to compare
- * @param other                        second key to compare
+ * @param private              private key to check
+ * @param other                        key to compare
  * @return                             TRUE if this is equal to other
  */
  * @return                             TRUE if this is equal to other
  */
-bool private_key_equals(private_key_t *this, private_key_t *other);
+bool private_key_equals(private_key_t *private, private_key_t *other);
 
 /**
 
 /**
- * Generic private key belongs_to() implementation, usable by implementors.
+ * Generic private key belongs_to() implementation, usable by implementers.
  *
  *
- * @param this                 first key to compare
- * @param other                        second key to compare
+ * @param private              private key to check
+ * @param public               public key to compare
  * @return                             TRUE if this is equal to other
  */
 bool private_key_belongs_to(private_key_t *private, public_key_t *public);
 
  * @return                             TRUE if this is equal to other
  */
 bool private_key_belongs_to(private_key_t *private, public_key_t *public);
 
+/**
+ * Generic private key has_fingerprint() implementation, usable by implementers.
+ *
+ * @param private              private key to check
+ * @param fingerprint  fingerprint to check
+ * @return                             TRUE if key has given fingerprint
+ */
+bool private_key_has_fingerprint(private_key_t *private, chunk_t fingerprint);
+
 #endif /** PRIVATE_KEY_H_ @}*/
 #endif /** PRIVATE_KEY_H_ @}*/