wolfssl-sys 4.0.0

System bindings for WolfSSL
Documentation
/* poly1305.h
 *
 * Copyright (C) 2006-2026 wolfSSL Inc.
 *
 * This file is part of wolfSSL.
 *
 * wolfSSL 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 3 of the License, or
 * (at your option) any later version.
 *
 * wolfSSL 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-1335, USA
 */

/*!
    \file wolfssl/wolfcrypt/poly1305.h
*/

#ifndef WOLF_CRYPT_POLY1305_H
#define WOLF_CRYPT_POLY1305_H

#include <wolfssl/wolfcrypt/types.h>

#ifdef HAVE_POLY1305

#ifdef __cplusplus
    extern "C" {
#endif

/* auto detect between 32bit / 64bit */
#if defined(__SIZEOF_INT128__) && defined(__LP64__)
#define WC_HAS_SIZEOF_INT128_64BIT
#endif

#if defined(_MSC_VER) && defined(_M_X64)
#define WC_HAS_MSVC_64BIT
#endif

#if (defined(__GNUC__) && defined(__LP64__) && \
        ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 4))))
#define WC_HAS_GCC_4_4_64BIT
#endif

#ifdef WOLFSSL_X86_64_BUILD
#if defined(USE_INTEL_SPEEDUP) && !defined(NO_POLY1305_ASM)
    #define USE_INTEL_POLY1305_SPEEDUP
    #define HAVE_INTEL_AVX1
#endif
#endif

#if defined(USE_INTEL_POLY1305_SPEEDUP)
#elif (defined(WC_HAS_SIZEOF_INT128_64BIT) || defined(WC_HAS_MSVC_64BIT) ||  \
       defined(WC_HAS_GCC_4_4_64BIT)) && !defined(WOLFSSL_W64_WRAPPER_TEST)
#define POLY130564
#else
#define POLY130532
#endif

enum {
    POLY1305 = 7,
    POLY1305_BLOCK_SIZE = 16,
    POLY1305_DIGEST_SIZE = 16
};

#define WC_POLY1305_PAD_SZ 16
#define WC_POLY1305_MAC_SZ 16

/* Poly1305 state */
typedef struct Poly1305 {
#ifdef USE_INTEL_POLY1305_SPEEDUP
    word64 r[3];
    word64 h[3];
    word64 pad[2];
    word64 hh[20];
    word32 r1[8];
    word32 r2[8];
    word32 r3[8];
    word32 r4[8];
    word64 hm[16];
    unsigned char buffer[8*POLY1305_BLOCK_SIZE];
    size_t leftover;
    unsigned char finished;
    unsigned char started;
#elif defined(WOLFSSL_ARMASM) && defined(__aarch64__)
    ALIGN8 word64 r64[2];
    ALIGN8 word32 r4[4];
    ALIGN8 word32 r3[4];
    ALIGN8 word32 r2[4];
    ALIGN8 word32 r1[4];
    ALIGN8 word32 r4321[4];
    ALIGN8 word32 h[6];
    ALIGN8 word32 pad[4];
    word64 leftover;
    unsigned char buffer[POLY1305_BLOCK_SIZE];
    unsigned char finished;
#elif defined(WOLFSSL_ARMASM) && !defined(WOLFSSL_ARMASM_THUMB2) && \
    !defined(WOLFSSL_ARMASM_NO_NEON)
    /* NEON implementation for ARM32 */
    word32 r[4];
    word32 h[6];
    word32 pad[4];
    word32 leftover;
    unsigned char buffer[4*POLY1305_BLOCK_SIZE];
    word32 r_21[10];
    word32 r_43[10];
    unsigned char finished;
#elif defined(WOLFSSL_ARMASM)
    /* ARM32 (non-NEON) and Thumb2 */
    word32 r[4];
    word32 h[5];
    word32 pad[4];
    word32 leftover;
    unsigned char buffer[POLY1305_BLOCK_SIZE];
    unsigned char finished;
#elif defined(WOLFSSL_RISCV_ASM)
    word64 r[2];
#ifdef WOLFSSL_RISCV_VECTOR
    word64 r2[6];
#endif
    word64 h[3];
    word64 pad[2];
    size_t leftover;
    unsigned char buffer[POLY1305_BLOCK_SIZE];
#else
#if defined(POLY130564)
    word64 r[3];
    word64 h[3];
    word64 pad[2];
#else
    word32 r[5];
    word32 h[5];
    word32 pad[4];
#endif
    size_t leftover;
    unsigned char buffer[POLY1305_BLOCK_SIZE];
    unsigned char finished;
#endif /* WOLFSSL_ARMASM */
} Poly1305;

/* does init */

WOLFSSL_API int wc_Poly1305SetKey(Poly1305* poly1305, const byte* key,
    word32 kySz);
WOLFSSL_API int wc_Poly1305Update(Poly1305* poly1305, const byte* m, word32 bytes);
WOLFSSL_API int wc_Poly1305Final(Poly1305* poly1305, byte* tag);

/* AEAD Functions */
WOLFSSL_API int wc_Poly1305_Pad(Poly1305* ctx, word32 lenToPad);
WOLFSSL_API int wc_Poly1305_EncodeSizes(Poly1305* ctx, word32 aadSz,
    word32 dataSz);
#ifdef WORD64_AVAILABLE
WOLFSSL_API int wc_Poly1305_EncodeSizes64(Poly1305* ctx, word64 aadSz,
     word64 dataSz);
#endif
WOLFSSL_API int wc_Poly1305_MAC(Poly1305* ctx, const byte* additional,
    word32 addSz, const byte* input, word32 sz, byte* tag, word32 tagSz);

#if defined(WOLFSSL_ARMASM)
#if defined(__aarch64__ )
void poly1305_arm64_block_16(Poly1305* ctx, const unsigned char* m);
void poly1305_arm64_blocks(Poly1305* ctx, const unsigned char* m, size_t bytes);

void poly1305_blocks_aarch64(Poly1305* ctx, const unsigned char *m,
    size_t bytes);
void poly1305_block_aarch64(Poly1305* ctx, const unsigned char *m);
#elif defined(WOLFSSL_ARMASM_THUMB2)
void poly1305_blocks_thumb2(Poly1305* ctx, const unsigned char *m,
    size_t bytes);
void poly1305_block_thumb2(Poly1305* ctx, const unsigned char *m);

void poly1305_blocks_thumb2_16(Poly1305* ctx, const unsigned char* m,
    word32 len, int notLast);
#else
void poly1305_blocks_arm32(Poly1305* ctx, const unsigned char *m, size_t bytes);
void poly1305_block_arm32(Poly1305* ctx, const unsigned char *m);

void poly1305_arm32_blocks(Poly1305* ctx, const unsigned char* m, word32 len);
void poly1305_arm32_blocks_16(Poly1305* ctx, const unsigned char* m, word32 len,
    int notLast);
#endif

void poly1305_set_key(Poly1305* ctx, const byte* key);
void poly1305_final(Poly1305* ctx, byte* mac);
#endif /* WOLFSSL_ARMASM */

#if defined(WOLFSSL_RISCV_ASM)
#define poly1305_blocks     poly1305_blocks_riscv64
#define poly1305_block      poly1305_block_riscv64

void poly1305_blocks_riscv64(Poly1305* ctx, const unsigned char *m,
    size_t bytes);
void poly1305_block_riscv64(Poly1305* ctx, const unsigned char *m);
#endif

#ifdef __cplusplus
    } /* extern "C" */
#endif

#endif /* HAVE_POLY1305 */
#endif /* WOLF_CRYPT_POLY1305_H */