internal-pyjamask.h 6.51 KB
Newer Older
Rhys Weatherley committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
/*
 * Copyright (C) 2020 Southern Storm Software, Pty Ltd.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef LW_INTERNAL_PYJAMASK_H
#define LW_INTERNAL_PYJAMASK_H

#include "internal-util.h"

/**
 * \file internal-pyjamask.h
 * \brief Pyjamask block cipher.
 */

#ifdef __cplusplus
extern "C" {
#endif

/**
 * \brief Number of rounds in the Pyjamask block cipher.
 */
#define PYJAMASK_ROUNDS 14

/**
 * \brief Number of parallel states for masked operation.
 */
#define PYJAMASK_MASKING_ORDER 4

/**
 * \brief Structure of the key schedule for Pyjamask block ciphers.
 */
typedef struct
{
    uint32_t k[(PYJAMASK_ROUNDS + 1) * 4]; /**< Words of the key schedule */

} pyjamask_key_schedule_t;

/**
 * \brief Structure of the key schedule for masked Pyjamask block ciphers.
 */
typedef struct
{
    /** Words of the key schedule */
    uint32_t k[PYJAMASK_MASKING_ORDER * (PYJAMASK_ROUNDS + 1) * 4];

} pyjamask_masked_key_schedule_t;

/**
 * \brief Sets up the key schedule for the Pyjamask block cipher.
 *
 * \param ks The key schedule on output.
 * \param key The 16 bytes of the key on input.
 */
void pyjamask_setup_key(pyjamask_key_schedule_t *ks, const unsigned char *key);

/**
 * \brief Encrypts a 128-bit block with Pyjamask-128.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 16 bytes in length.
 * \param input Input buffer which must be at least 16 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place encryption.
 *
 * \sa pyjamask_128_decrypt()
 */
void pyjamask_128_encrypt
    (const pyjamask_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

/**
 * \brief Decrypts a 128-bit block with Pyjamask-128.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 16 bytes in length.
 * \param input Input buffer which must be at least 16 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place decryption.
 *
 * \sa pyjamask_128_encrypt()
 */
void pyjamask_128_decrypt
    (const pyjamask_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

/**
 * \brief Encrypts a 96-bit block with Pyjamask-96.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 12 bytes in length.
 * \param input Input buffer which must be at least 12 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place encryption.
 *
 * \sa pyjamask_96_decrypt()
 */
void pyjamask_96_encrypt
    (const pyjamask_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

/**
 * \brief Decrypts a 96-bit block with Pyjamask-96.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 12 bytes in length.
 * \param input Input buffer which must be at least 12 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place decryption.
 *
 * \sa pyjamask_96_encrypt()
 */
void pyjamask_96_decrypt
    (const pyjamask_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

/**
 * \brief Sets up the key schedule for the masked Pyjamask block cipher.
 *
 * \param ks The key schedule on output.
 * \param key The 16 bytes of the key on input.
 */
void pyjamask_masked_setup_key
    (pyjamask_masked_key_schedule_t *ks, const unsigned char *key);

/**
 * \brief Encrypts a 128-bit block with Pyjamask-128 in masked mode.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 16 bytes in length.
 * \param input Input buffer which must be at least 16 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place encryption.
 *
 * \sa pyjamask_masked_128_decrypt()
 */
void pyjamask_masked_128_encrypt
    (const pyjamask_masked_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

/**
 * \brief Decrypts a 128-bit block with Pyjamask-128 in masked mode.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 16 bytes in length.
 * \param input Input buffer which must be at least 16 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place decryption.
 *
 * \sa pyjamask_masked_128_encrypt()
 */
void pyjamask_masked_128_decrypt
    (const pyjamask_masked_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

/**
 * \brief Encrypts a 96-bit block with Pyjamask-96 in masked mode.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 12 bytes in length.
 * \param input Input buffer which must be at least 12 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place encryption.
 *
 * \sa pyjamask_masked_96_decrypt()
 */
void pyjamask_masked_96_encrypt
    (const pyjamask_masked_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

/**
 * \brief Decrypts a 96-bit block with Pyjamask-96 in masked mode.
 *
 * \param ks Points to the key schedule.
 * \param output Output buffer which must be at least 12 bytes in length.
 * \param input Input buffer which must be at least 12 bytes in length.
 *
 * The \a input and \a output buffers can be the same buffer for
 * in-place decryption.
 *
 * \sa pyjamask_masked_96_encrypt()
 */
void pyjamask_masked_96_decrypt
    (const pyjamask_masked_key_schedule_t *ks, unsigned char *output,
     const unsigned char *input);

#ifdef __cplusplus
}
#endif

#endif