steelcrypt/src/crypto_generic_types.ads

107 lines
5.0 KiB
Ada

-- Copyright (C) 2015 Daniel Otte <bg@nerilex.org>
--
-- 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 3 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, see <http://www.gnu.org/licenses/>.
with Crypto_Core_Types; use Crypto_Core_Types;
-- --------------------------
-- - Generic Functions / Procedures -
-- --------------------------
generic
type T is mod <>;
with function Shift_Left
(Value : T;
Amount : Natural) return T is <>;
with function Shift_Right
(Value : T;
Amount : Natural) return T is <>;
with function Rotate_Left
(Value : T;
Amount : Natural) return T is <>;
with function Rotate_Right
(Value : T;
Amount : Natural) return T is <>;
type T_Array is Array (Integer range <>) of T;
type T_Array_Access is access T_Array;
-- --------------------------
-- - Functions / Procedures -
-- --------------------------
package Crypto_Generic_Types is
-- compare two array with timing independent of content
-- function "="(Left, Right : T_Array ) return Boolean;
-- xor each element on the left with the corresponding element on the right
function "xor"(Left, Right : T_Array ) return T_Array;
-- xor the left element with each element on the right
function "xor"(Left : T; Right : T_Array ) return T;
-- xor each element on the left with the element on the right
function "xor"(Left : T_Array; Right : T ) return T_Array;
-- and each element on the left with the corresponding element on the right
function "and"(Left, Right : T_Array ) return T_Array;
-- and the left element with each element on the right
function "and"(Left : T; Right : T_Array ) return T;
-- and each element on the left with the element on the right
function "and"(Left : T_Array; Right : T ) return T_Array;
-- or each element on the left with the corresponding element on the right
function "or"(Left, Right : T_Array ) return T_Array;
-- or the left element with each element on the right
function "or"(Left : T; Right : T_Array ) return T;
-- or each element on the left with the element on the right
function "or"(Left : T_Array; Right : T ) return T_Array;
-- add each element on the left with the corresponding element on the right
function "+"(Left, Right : T_Array ) return T_Array;
-- add the left element with each element on the right
function "+"(Left : T; Right : T_Array ) return T;
-- add each element on the left with the element on the right
function "+"(Left : T_Array; Right : T ) return T_Array;
-- subtract from each element on the left the corresponding element on the right
function "-"(Left, Right : T_Array ) return T_Array;
-- subtract from the left element each element on the right
function "-"(Left : T; Right : T_Array ) return T;
-- subtract from each element on the left the element on the right
function "-"(Left : T_Array; Right : T ) return T_Array;
-- rotate the whole Array as continues big-endian integer; positive Amount rotates left (towards lower address)
function Rotate_be(A : T_Array; Amount : Integer) return T_Array;
-- rotate the whole Array as continues little-endian integer; positive Amount rotates left (towards higher address)
function Rotate_le(A : T_Array; Amount : Integer) return T_Array;
-- rotate each element by Amount to the left; negative values for Amount rotate to the right
function Rotate_each(A : T_Array; Amount : Integer) return T_Array;
-- shift the whole Array as continues big-endian integer; positive Amount shifts left (towards lower address)
function Shift_be(A : T_Array; Amount : Integer) return T_Array;
-- Shift the whole Array as continues little-endian integer; positive Amount shifts left (towards higher address)
function Shift_le(A : T_Array; Amount : Integer) return T_Array;
-- shift each element by Amount to the left; negative values for Amount shift to the right
function Shift_each(A : T_Array; Amount : Integer) return T_Array;
-- load a value which is stored big-endian in byte Array
function Load_be (A : u8_Array) return T;
-- load a value which is stored little-endian in byte Array
function Load_le(A : u8_Array) return T;
-- store a value in big-endian format in a byte Array
procedure Store_be(A : out u8_Array; value : in T);
-- store a value in little-endian format in a byte Array
procedure Store_le(A : out u8_Array; value : in T);
-- swap two elements
procedure Swap(A, B : in out T);
end Crypto_Generic_Types;