x509_signature.h File Reference

RSA/DSA/ECDSA/EdDSA signature generation and verification. More...

#include "core/crypto.h"
#include "pkix/x509_common.h"

Go to the source code of this file.

Macros

#define X509_SIGN_CALLBACK_SUPPORT   DISABLED
 

Typedefs

typedef error_t(* X509SignGenCallback) (const PrngAlgo *prngAlgo, void *prngContext, const uint8_t *tbsCert, size_t tbsCertLen, const X509SignatureAlgoId *signatureAlgoId, const X509SubjectPublicKeyInfo *publicKeyInfo, const void *privateKey, uint8_t *output, size_t *written)
 Signature generation callback function. More...
 
typedef error_t(* X509SignVerifyCallback) (const uint8_t *tbsCert, size_t tbsCertLen, const X509SignatureAlgoId *signatureAlgoId, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 Signature verification callback function. More...
 

Functions

error_t x509RegisterSignGenCallback (X509SignGenCallback callback)
 Register signature generation callback function. More...
 
error_t x509RegisterSignVerifyCallback (X509SignVerifyCallback callback)
 Register signature verification callback function. More...
 
error_t x509GenerateSignature (const PrngAlgo *prngAlgo, void *prngContext, const uint8_t *tbsCert, size_t tbsCertLen, const X509SignatureAlgoId *signatureAlgoId, const X509SubjectPublicKeyInfo *publicKeyInfo, const void *privateKey, uint8_t *output, size_t *written)
 Certificate signature generation. More...
 
error_t x509GenerateRsaSignature (const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, const RsaPrivateKey *privateKey, uint8_t *output, size_t *written)
 RSA signature generation. More...
 
error_t x509GenerateRsaPssSignature (const PrngAlgo *prngAlgo, void *prngContext, const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, size_t saltLen, const RsaPrivateKey *privateKey, uint8_t *output, size_t *written)
 RSA-PSS signature generation. More...
 
error_t x509GenerateDsaSignature (const PrngAlgo *prngAlgo, void *prngContext, const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, const DsaPrivateKey *privateKey, uint8_t *output, size_t *written)
 DSA signature generation. More...
 
error_t x509GenerateEcdsaSignature (const PrngAlgo *prngAlgo, void *prngContext, const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, const X509SubjectPublicKeyInfo *publicKeyInfo, const EcPrivateKey *privateKey, uint8_t *output, size_t *written)
 ECDSA signature generation. More...
 
error_t x509GenerateEd25519Signature (const uint8_t *tbsCert, size_t tbsCertLen, const EddsaPrivateKey *privateKey, uint8_t *output, size_t *written)
 Ed25519 signature generation. More...
 
error_t x509GenerateEd448Signature (const uint8_t *tbsCert, size_t tbsCertLen, const EddsaPrivateKey *privateKey, uint8_t *output, size_t *written)
 Ed448 signature generation. More...
 
error_t x509VerifySignature (const uint8_t *tbsCert, size_t tbsCertLen, const X509SignatureAlgoId *signatureAlgoId, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 Certificate signature verification. More...
 
error_t x509VerifyRsaSignature (const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 RSA signature verification. More...
 
error_t x509VerifyRsaPssSignature (const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, size_t saltLen, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 RSA-PSS signature verification. More...
 
error_t x509VerifyDsaSignature (const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 DSA signature verification. More...
 
error_t x509VerifyEcdsaSignature (const uint8_t *tbsCert, size_t tbsCertLen, const HashAlgo *hashAlgo, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 ECDSA signature verification. More...
 
error_t x509VerifyEd25519Signature (const uint8_t *tbsCert, size_t tbsCertLen, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 Ed25519 signature verification. More...
 
error_t x509VerifyEd448Signature (const uint8_t *tbsCert, size_t tbsCertLen, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)
 Ed448 signature verification. More...
 

Detailed Description

RSA/DSA/ECDSA/EdDSA signature generation and verification.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2023 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneCRYPTO Open.

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 Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.2.2

Definition in file x509_signature.h.

Macro Definition Documentation

◆ X509_SIGN_CALLBACK_SUPPORT

#define X509_SIGN_CALLBACK_SUPPORT   DISABLED

Definition at line 40 of file x509_signature.h.

Typedef Documentation

◆ X509SignGenCallback

typedef error_t(* X509SignGenCallback) (const PrngAlgo *prngAlgo, void *prngContext, const uint8_t *tbsCert, size_t tbsCertLen, const X509SignatureAlgoId *signatureAlgoId, const X509SubjectPublicKeyInfo *publicKeyInfo, const void *privateKey, uint8_t *output, size_t *written)

Signature generation callback function.

Definition at line 55 of file x509_signature.h.

◆ X509SignVerifyCallback

typedef error_t(* X509SignVerifyCallback) (const uint8_t *tbsCert, size_t tbsCertLen, const X509SignatureAlgoId *signatureAlgoId, const X509SubjectPublicKeyInfo *publicKeyInfo, const X509SignatureValue *signatureValue)

Signature verification callback function.

Definition at line 66 of file x509_signature.h.

Function Documentation

◆ x509GenerateDsaSignature()

error_t x509GenerateDsaSignature ( const PrngAlgo prngAlgo,
void *  prngContext,
const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
const DsaPrivateKey privateKey,
uint8_t *  output,
size_t *  written 
)

DSA signature generation.

Parameters
[in]prngAlgoPRNG algorithm
[in]prngContextPointer to the PRNG context
[in]tbsCertPointer to the TBSCertificate to be signed
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]privateKeySigner's private key
[out]outputResulting signature
[out]writtenLength of the resulting signature
Returns
Error code

Definition at line 313 of file x509_signature.c.

◆ x509GenerateEcdsaSignature()

error_t x509GenerateEcdsaSignature ( const PrngAlgo prngAlgo,
void *  prngContext,
const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
const X509SubjectPublicKeyInfo publicKeyInfo,
const EcPrivateKey privateKey,
uint8_t *  output,
size_t *  written 
)

ECDSA signature generation.

Parameters
[in]prngAlgoPRNG algorithm
[in]prngContextPointer to the PRNG context
[in]tbsCertPointer to the TBSCertificate to be signed
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]publicKeyInfoSigner's public key information
[in]privateKeySigner's private key
[out]outputResulting signature
[out]writtenLength of the resulting signature
Returns
Error code

Definition at line 369 of file x509_signature.c.

◆ x509GenerateEd25519Signature()

error_t x509GenerateEd25519Signature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const EddsaPrivateKey privateKey,
uint8_t *  output,
size_t *  written 
)

Ed25519 signature generation.

Parameters
[in]tbsCertPointer to the TBSCertificate to be signed
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]privateKeySigner's private key
[out]outputResulting signature
[out]writtenLength of the resulting signature
Returns
Error code

Definition at line 447 of file x509_signature.c.

◆ x509GenerateEd448Signature()

error_t x509GenerateEd448Signature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const EddsaPrivateKey privateKey,
uint8_t *  output,
size_t *  written 
)

Ed448 signature generation.

Parameters
[in]tbsCertPointer to the TBSCertificate to be signed
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]privateKeySigner's private key
[out]outputResulting signature
[out]writtenLength of the resulting signature
Returns
Error code

Definition at line 498 of file x509_signature.c.

◆ x509GenerateRsaPssSignature()

error_t x509GenerateRsaPssSignature ( const PrngAlgo prngAlgo,
void *  prngContext,
const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
size_t  saltLen,
const RsaPrivateKey privateKey,
uint8_t *  output,
size_t *  written 
)

RSA-PSS signature generation.

Parameters
[in]prngAlgoPRNG algorithm
[in]prngContextPointer to the PRNG context
[in]tbsCertPointer to the TBSCertificate to be signed
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]saltLenLength of the salt, in bytes
[in]privateKeySigner's private key
[out]outputResulting signature
[out]writtenLength of the resulting signature
Returns
Error code

Definition at line 271 of file x509_signature.c.

◆ x509GenerateRsaSignature()

error_t x509GenerateRsaSignature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
const RsaPrivateKey privateKey,
uint8_t *  output,
size_t *  written 
)

RSA signature generation.

Parameters
[in]tbsCertPointer to the TBSCertificate to be signed
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]privateKeySigner's private key
[out]outputResulting signature
[out]writtenLength of the resulting signature
Returns
Error code

Definition at line 229 of file x509_signature.c.

◆ x509GenerateSignature()

error_t x509GenerateSignature ( const PrngAlgo prngAlgo,
void *  prngContext,
const uint8_t *  tbsCert,
size_t  tbsCertLen,
const X509SignatureAlgoId signatureAlgoId,
const X509SubjectPublicKeyInfo publicKeyInfo,
const void *  privateKey,
uint8_t *  output,
size_t *  written 
)

Certificate signature generation.

Parameters
[in]prngAlgoPRNG algorithm
[in]prngContextPointer to the PRNG context
[in]tbsCertPointer to the TBSCertificate to be signed
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]signatureAlgoIdSignature algorithm identifier
[in]publicKeyInfoSigner's public key information
[in]privateKeySigner's private key
[out]outputResulting signature
[out]writtenLength of the resulting signature
Returns
Error code

Definition at line 108 of file x509_signature.c.

◆ x509RegisterSignGenCallback()

error_t x509RegisterSignGenCallback ( X509SignGenCallback  callback)

Register signature generation callback function.

Parameters
[in]callbackSignature generation callback function
Returns
Error code

Definition at line 60 of file x509_signature.c.

◆ x509RegisterSignVerifyCallback()

error_t x509RegisterSignVerifyCallback ( X509SignVerifyCallback  callback)

Register signature verification callback function.

Parameters
[in]callbackSignature verification callback function
Returns
Error code

Definition at line 80 of file x509_signature.c.

◆ x509VerifyDsaSignature()

error_t x509VerifyDsaSignature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
const X509SubjectPublicKeyInfo publicKeyInfo,
const X509SignatureValue signatureValue 
)

DSA signature verification.

Parameters
[in]tbsCertTBSCertificate whose signature is to be verified
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]publicKeyInfoIssuer's public key
[in]signatureValueSignature to be verified
Returns
Error code

Definition at line 802 of file x509_signature.c.

◆ x509VerifyEcdsaSignature()

error_t x509VerifyEcdsaSignature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
const X509SubjectPublicKeyInfo publicKeyInfo,
const X509SignatureValue signatureValue 
)

ECDSA signature verification.

Parameters
[in]tbsCertTBSCertificate whose signature is to be verified
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]publicKeyInfoIssuer's public key
[in]signatureValueSignature to be verified
Returns
Error code

Definition at line 881 of file x509_signature.c.

◆ x509VerifyEd25519Signature()

error_t x509VerifyEd25519Signature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const X509SubjectPublicKeyInfo publicKeyInfo,
const X509SignatureValue signatureValue 
)

Ed25519 signature verification.

Parameters
[in]tbsCertTBSCertificate whose signature is to be verified
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]publicKeyInfoIssuer's public key
[in]signatureValueSignature to be verified
Returns
Error code

Definition at line 970 of file x509_signature.c.

◆ x509VerifyEd448Signature()

error_t x509VerifyEd448Signature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const X509SubjectPublicKeyInfo publicKeyInfo,
const X509SignatureValue signatureValue 
)

Ed448 signature verification.

Parameters
[in]tbsCertTBSCertificate whose signature is to be verified
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]publicKeyInfoIssuer's public key
[in]signatureValueSignature to be verified
Returns
Error code

Definition at line 1017 of file x509_signature.c.

◆ x509VerifyRsaPssSignature()

error_t x509VerifyRsaPssSignature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
size_t  saltLen,
const X509SubjectPublicKeyInfo publicKeyInfo,
const X509SignatureValue signatureValue 
)

RSA-PSS signature verification.

Parameters
[in]tbsCertTBSCertificate whose signature is to be verified
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]saltLenLength of the salt, in bytes
[in]publicKeyInfoIssuer's public key
[in]signatureValueSignature to be verified
Returns
Error code

Definition at line 734 of file x509_signature.c.

◆ x509VerifyRsaSignature()

error_t x509VerifyRsaSignature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const HashAlgo hashAlgo,
const X509SubjectPublicKeyInfo publicKeyInfo,
const X509SignatureValue signatureValue 
)

RSA signature verification.

Parameters
[in]tbsCertTBSCertificate whose signature is to be verified
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]hashAlgoUnderlying hash function
[in]publicKeyInfoIssuer's public key
[in]signatureValueSignature to be verified
Returns
Error code

Definition at line 666 of file x509_signature.c.

◆ x509VerifySignature()

error_t x509VerifySignature ( const uint8_t *  tbsCert,
size_t  tbsCertLen,
const X509SignatureAlgoId signatureAlgoId,
const X509SubjectPublicKeyInfo publicKeyInfo,
const X509SignatureValue signatureValue 
)

Certificate signature verification.

Parameters
[in]tbsCertTBSCertificate whose signature is to be verified
[in]tbsCertLenLength of the TBSCertificate, in bytes
[in]signatureAlgoIdSignature algorithm identifier
[in]publicKeyInfoIssuer's public key
[in]signatureValueSignature to be verified
Returns
Error code

Definition at line 549 of file x509_signature.c.