--  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;

package Pi32Cipher_Spec is

   type Context_T is private;

   Cipher_Name : constant String := "pi32cipher";
   Width_Bits : constant := 32;

   N : constant := 4;
   R : constant := 3;

   IS_Bits : constant := (N * 4 * Width_Bits);
   IS_Bytes : constant := IS_Bits / 8;
   Rate_Bits : constant := IS_Bits / 2;
   Rate_Bytes : constant := Rate_Bits / 8;
   Capacity_Bits : constant := IS_Bits - Rate_Bits;
   Capacity_Bytes : constant := Capacity_Bits / 8;
   Block_Bits : constant := Rate_Bits;
   Block_Bytes : constant := Block_Bits / 8;
   Tag_Bits : constant := Rate_Bits;
   Tag_Bytes : constant := Tag_Bits / 8;
   Secret_Message_Number_Bits : constant := Block_Bits;
   Secret_Message_Number_Bytes : constant := Secret_Message_Number_Bits / 8;

   subtype Block_Number_T is Natural;
   subtype Block_T is u8_Array (1 .. Rate_Bytes);
   subtype Tag_T is u8_Array(1 .. Rate_Bytes);

   procedure Initialize(Context : out Context_T; Key : in u8_Array; Public_Nonce : in u8_Array);
   procedure Process_Header_Block (Context : in out Context_T; Block : Block_T; Block_Number : Block_Number_T);
   procedure Process_Header_Last_Block (Context : in out Context_T; Block : u8_Array; Block_Number : Block_Number_T);
   procedure Encrypt_Secret_Message_Number(Context : in out Context_T; Block : in out u8_Array);
   procedure Decrypt_Secret_Message_Number(Context : in out Context_T; Block : in out u8_Array);
   procedure Encrypt_Block(Context : in out Context_T; Block : in out Block_T; Block_Number : Block_Number_T);
   procedure Decrypt_Block(Context : in out Context_T; Block : in out Block_T; Block_Number : Block_Number_T);
   procedure Encrypt_Last_Block(Context : in out Context_T; Block : in out u8_Array; Block_Number : Block_Number_T);
   procedure Decrypt_Last_Block(Context : in out Context_T; Block : in out u8_Array; Block_Number : Block_Number_T);
   function Get_Tag(Context : Context_T) return Tag_T;
   function Is_Valid(Is_Tag : in Tag_T; Should_Tag : in Tag_T) return Boolean;
   function Is_Valid(Context : in Context_T; Should_Tag : in Tag_T) return Boolean;

   function Encrypt(Msg : u8_Array; AD : u8_Array; Public_Nonce : u8_Array; Secret_Nonce : u8_Array; Key : u8_Array) return u8_Array;
   procedure Decrypt(Is_Valid : out Boolean; Msg : out u8_Array; Secret_Nonce : out u8_Array; Cipher : in u8_Array; AD : in u8_Array; Public_Nonce : in u8_Array; Key : in u8_Array);


private

   subtype Word_T is u32;
   subtype Chunk_T is u32_Array(1 .. 4);
   subtype Tag_Int_T is u32_Array(1 .. 4 * N / 2);

   type State_T is array (1 .. N) of Chunk_T;

   type Context_T is record
      State : State_T;
      Tag : Tag_Int_T;
      Counter : u64;
   end record;

end Pi32Cipher_Spec;
