sm3.h File Reference

SM3 hash function. More...

#include "core/crypto.h"

Go to the source code of this file.

Data Structures

struct  Sm3Context
 SM3 algorithm context. More...
 

Macros

#define SM3_PRIVATE_CONTEXT
 
#define SM3_BLOCK_SIZE   64
 
#define SM3_DIGEST_SIZE   32
 
#define SM3_MIN_PAD_SIZE   9
 
#define SM3_HASH_ALGO   (&sm3HashAlgo)
 

Functions

error_t sm3Compute (const void *data, size_t length, uint8_t *digest)
 Digest a message using SM3. More...
 
void sm3Init (Sm3Context *context)
 Initialize SM3 message digest context. More...
 
void sm3Update (Sm3Context *context, const void *data, size_t length)
 Update the SM3 context with a portion of the message being hashed. More...
 
void sm3Final (Sm3Context *context, uint8_t *digest)
 Finish the SM3 message digest. More...
 
void sm3FinalRaw (Sm3Context *context, uint8_t *digest)
 Finish the SM3 message digest (no padding added) More...
 
void sm3ProcessBlock (Sm3Context *context)
 Process message in 16-word blocks. More...
 

Variables

const uint8_t SM3_OID [6]
 
const HashAlgo sm3HashAlgo
 

Detailed Description

SM3 hash function.

License

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

Copyright (C) 2010-2024 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.4.0

Definition in file sm3.h.

Macro Definition Documentation

◆ SM3_BLOCK_SIZE

#define SM3_BLOCK_SIZE   64

Definition at line 43 of file sm3.h.

◆ SM3_DIGEST_SIZE

#define SM3_DIGEST_SIZE   32

Definition at line 45 of file sm3.h.

◆ SM3_HASH_ALGO

#define SM3_HASH_ALGO   (&sm3HashAlgo)

Definition at line 49 of file sm3.h.

◆ SM3_MIN_PAD_SIZE

#define SM3_MIN_PAD_SIZE   9

Definition at line 47 of file sm3.h.

◆ SM3_PRIVATE_CONTEXT

#define SM3_PRIVATE_CONTEXT

Definition at line 39 of file sm3.h.

Function Documentation

◆ sm3Compute()

error_t sm3Compute ( const void *  data,
size_t  length,
uint8_t *  digest 
)

Digest a message using SM3.

Parameters
[in]dataPointer to the message being hashed
[in]lengthLength of the message
[out]digestPointer to the calculated digest
Returns
Error code

Definition at line 95 of file sm3.c.

◆ sm3Final()

void sm3Final ( Sm3Context context,
uint8_t *  digest 
)

Finish the SM3 message digest.

Parameters
[in]contextPointer to the SM3 context
[out]digestCalculated digest (optional parameter)

Definition at line 205 of file sm3.c.

◆ sm3FinalRaw()

void sm3FinalRaw ( Sm3Context context,
uint8_t *  digest 
)

Finish the SM3 message digest (no padding added)

Parameters
[in]contextPointer to the SM3 context
[out]digestCalculated digest

Definition at line 254 of file sm3.c.

◆ sm3Init()

void sm3Init ( Sm3Context context)

Initialize SM3 message digest context.

Parameters
[in]contextPointer to the SM3 context to initialize

Definition at line 140 of file sm3.c.

◆ sm3ProcessBlock()

void sm3ProcessBlock ( Sm3Context context)

Process message in 16-word blocks.

Parameters
[in]contextPointer to the SM3 context

Definition at line 280 of file sm3.c.

◆ sm3Update()

void sm3Update ( Sm3Context context,
const void *  data,
size_t  length 
)

Update the SM3 context with a portion of the message being hashed.

Parameters
[in]contextPointer to the SM3 context
[in]dataPointer to the buffer being hashed
[in]lengthLength of the buffer

Definition at line 166 of file sm3.c.

Variable Documentation

◆ SM3_OID

const uint8_t SM3_OID[6]
extern

Definition at line 66 of file sm3.c.

◆ sm3HashAlgo

const HashAlgo sm3HashAlgo
extern

Definition at line 69 of file sm3.c.