X-Git-Url: https://git.cryptolib.org/?a=blobdiff_plain;f=shabea.h;h=28432a2c5c2b26e31f2db2e063d353f57dec5c14;hb=a15d02c94b1ce1fc9861e654e96e0ee369fe08e9;hp=5388f448cc5d0a1693de76fa8c2f64910d79375f;hpb=639b9bea16571c3f3a901cefc4bca48f84b09705;p=avr-crypto-lib.git

diff --git a/shabea.h b/shabea.h
index 5388f44..28432a2 100644
--- a/shabea.h
+++ b/shabea.h
@@ -1,10 +1,27 @@
+/* shabea.h */
+/*
+    This file is part of the Crypto-avr-lib/microcrypt-lib.
+    Copyright (C) 2008  Daniel Otte (daniel.otte@rub.de)
+
+    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/>.
+*/
 /**
  * \file	shabea.h
  * \author	Daniel Otte 
  * \date	2007-06-07
- * \brief	SHABEA - a SHA Based Encrytion Algorithm declarations
- * \par License	
- * GPL
+ * \brief	SHABEA - a SHA Based Encryption Algorithm declarations
+ * \license	GPLv3 or later
  * 
  * SHABEAn-r where n is the blocksize and r the number of round used
  * 
@@ -13,5 +30,16 @@
 #ifndef SHABEA_H_
 #define SHABEA_H_
 
-void shabea256(void * block, void * key, uint16_t keysize, uint8_t enc, uint8_t rounds);
+/** \fn void shabea256(void * block, const void * key, uint16_t keysize_b, uint8_t enc, uint8_t rounds);
+ * \brief shabea256 encryption/decryption
+ * 
+ * \param block pointer to a 256 bit (32 byte block) to en/decrypt
+ * \param key   pointer to the key material
+ * \param keysize_b length of the key in bits
+ * \param enc  controls if encryption (1) or decryption (0) is done
+ * \param rounds rounds to be done by the cipher (it is not recommended to use less then four rounds)
+ */
+void shabea256(void * block, const void * key, uint16_t keysize_b, 
+               uint8_t enc, uint8_t rounds);
+
 #endif /*SHABEA_H_*/