/usr/include/beecrypt/beecrypt.h is in libbeecrypt-dev 4.2.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 | /*
* Copyright (c) 1999, 2000, 2001, 2002 X-Way Rights BV
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
/*!\file beecrypt.h
* \brief BeeCrypt API, headers.
*
* These API functions provide an abstract way for using most of
* the various algorithms implemented by the library.
*
* \author Bob Deblier <bob.deblier@telenet.be>
* \ingroup ES_m PRNG_m HASH_m HMAC_m BC_m
*/
#ifndef _BEECRYPT_H
#define _BEECRYPT_H
#include "beecrypt/api.h"
#include "beecrypt/memchunk.h"
#include "beecrypt/mpnumber.h"
/*
* Entropy Sources
*/
/*!\typedef entropyNext
* \brief Prototype definition for an entropy-generating function.
* \ingroup ES_m
*/
typedef int (*entropyNext)(byte*, size_t);
/*!\brief This struct holds information and pointers to code specific to each
* source of entropy.
* \ingroup ES_m
*/
#ifdef __cplusplus
struct BEECRYPTAPI entropySource
#else
struct _entropySource
#endif
{
/*!\var name
* \brief The entropy source's name.
*/
const char* name;
/*!\var next
* \brief Points to the function which produces the entropy.
*/
const entropyNext next;
};
#ifndef __cplusplus
typedef struct _entropySource entropySource;
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*!\fn int entropySourceCount()
* \brief This function returns the number of entropy sources implemented by
* the library.
* \return The number of implemented entropy sources.
*/
BEECRYPTAPI
int entropySourceCount(void);
/*!\fn const entropySource* entropySourceGet(int n)
* \brief This function returns the \a n -th entropy source implemented by
* the library.
* \param n Index of the requested entropy source; legal values are 0
* through entropySourceCount() - 1.
* \return A pointer to an entropy source or null, if the index was out of
* range.
*/
BEECRYPTAPI
const entropySource* entropySourceGet(int n);
/*!\fn const entropySource* entropySourceFind(const char* name)
* \brief This function returns the entropy source specified by the given name.
* \param name Name of the requested entropy source.
* \return A pointer to an entropy source or null, if the name wasn't found.
*/
BEECRYPTAPI
const entropySource* entropySourceFind(const char* name);
/*!\fn const entropySource* entropySourceDefault()
* \brief This functions returns the default entropy source; the default value
* can be specified by setting environment variable BEECRYPT_ENTROPY.
* \return A pointer to an entropy source or null, in case an error occured.
*/
BEECRYPTAPI
const entropySource* entropySourceDefault(void);
/*!\fn int entropyGatherNext(byte* data, size_t size)
* \brief This function gathers \a size bytes of entropy into \a data.
*
* Unless environment variable BEECRYPT_ENTROPY is set, this function will
* try each successive entropy source to gather up the requested amount.
*
* \param data Points to where the entropy should be stored.
* \param size Indicates how many bytes of entropy should be gathered.
* \retval 0 On success.
* \retval -1 On failure.
*/
BEECRYPTAPI
int entropyGatherNext(byte*, size_t);
#ifdef __cplusplus
}
#endif
/*
* Pseudo-random Number Generators
*/
typedef void randomGeneratorParam;
typedef int (*randomGeneratorSetup )(randomGeneratorParam*);
typedef int (*randomGeneratorSeed )(randomGeneratorParam*, const byte*, size_t);
typedef int (*randomGeneratorNext )(randomGeneratorParam*, byte*, size_t);
typedef int (*randomGeneratorCleanup)(randomGeneratorParam*);
/*
* The struct 'randomGenerator' holds information and pointers to code specific
* to each random generator. Each specific random generator MUST be written to
* be multithread safe.
*
* WARNING: each randomGenerator, when used in cryptographic applications, MUST
* be guaranteed to be of suitable quality and strength (i.e. don't use the
* random() function found in most UN*X-es).
*
* Multiple instances of each randomGenerator can be used (even concurrently),
* provided they each use their own randomGeneratorParam parameters, a chunk
* of memory which must be at least as large as indicated by the paramsize
* field.
*
*/
/*!\brief This struct holds information and pointers to code specific to each
* pseudo-random number generator.
* \ingroup PRNG_m
*/
#ifdef __cplusplus
struct BEECRYPTAPI randomGenerator
#else
struct _randomGenerator
#endif
{
/*!\var name
* \brief The random generator's name.
*/
const char* name;
/*!\var paramsize
* \brief The size of the random generator's parameters.
* \note The implementor should set this by using sizeof(<struct holding
* random generator's parameters>).
*/
const size_t paramsize;
/*!\var setup
* \brief Points to the setup function.
*/
const randomGeneratorSetup setup;
/*!\var seed
* \brief Points to the seeding function.
*/
const randomGeneratorSeed seed;
/*!\var seed
* \brief Points to the function which generates the random data.
*/
const randomGeneratorNext next;
/*!\var seed
* \brief Points to the cleanup function.
*/
const randomGeneratorCleanup cleanup;
};
#ifndef __cplusplus
typedef struct _randomGenerator randomGenerator;
#endif
/*
* You can use the following functions to find random generators implemented by
* the library:
*
* randomGeneratorCount returns the number of generators available.
*
* randomGeneratorGet returns the random generator with a given index (starting
* at zero, up to randomGeneratorCount() - 1), or NULL if the index was out of
* bounds.
*
* randomGeneratorFind returns the random generator with the given name, or
* NULL if no random generator exists with that name.
*/
#ifdef __cplusplus
extern "C" {
#endif
BEECRYPTAPI
int randomGeneratorCount(void);
BEECRYPTAPI
const randomGenerator* randomGeneratorGet(int);
BEECRYPTAPI
const randomGenerator* randomGeneratorFind(const char*);
BEECRYPTAPI
const randomGenerator* randomGeneratorDefault(void);
#ifdef __cplusplus
}
#endif
/*
* The struct 'randomGeneratorContext' is used to contain both the functional
* part (the randomGenerator), and its parameters.
*/
#ifdef __cplusplus
struct BEECRYPTAPI randomGeneratorContext
#else
struct _randomGeneratorContext
#endif
{
const randomGenerator* rng;
randomGeneratorParam* param;
#ifdef __cplusplus
randomGeneratorContext();
randomGeneratorContext(const randomGenerator*);
~randomGeneratorContext();
#endif
};
#ifndef __cplusplus
typedef struct _randomGeneratorContext randomGeneratorContext;
#endif
/*
* The following functions can be used to initialize and free a
* randomGeneratorContext. Initializing will allocate a buffer of the size
* required by the randomGenerator, freeing will deallocate that buffer.
*/
#ifdef __cplusplus
extern "C" {
#endif
BEECRYPTAPI
int randomGeneratorContextInit(randomGeneratorContext*, const randomGenerator*);
BEECRYPTAPI
int randomGeneratorContextFree(randomGeneratorContext*);
BEECRYPTAPI
int randomGeneratorContextNext(randomGeneratorContext*, byte*, size_t);
BEECRYPTAPI
int randomGeneratorContextSeed(randomGeneratorContext*, const byte*, size_t);
#ifdef __cplusplus
}
#endif
/*
* Hash Functions
*/
/*!typedef void hashFunctionParam
* \ingroup HASH_m
*/
typedef void hashFunctionParam;
typedef int (*hashFunctionReset )(hashFunctionParam*);
typedef int (*hashFunctionUpdate)(hashFunctionParam*, const byte*, size_t);
typedef int (*hashFunctionDigest)(hashFunctionParam*, byte*);
/*
* The struct 'hashFunction' holds information and pointers to code specific
* to each hash function. Specific hash functions MAY be written to be
* multithread-safe.
*
* NOTE: data MUST have a size (in bytes) of at least 'digestsize' as described
* in the hashFunction struct.
* NOTE: for safety reasons, after calling digest, each specific implementation
* MUST reset itself so that previous values in the parameters are erased.
*/
#ifdef __cplusplus
struct BEECRYPTAPI hashFunction
#else
struct _hashFunction
#endif
{
const char* name;
const size_t paramsize; /* in bytes */
const size_t blocksize; /* in bytes */
const size_t digestsize; /* in bytes */
const hashFunctionReset reset;
const hashFunctionUpdate update;
const hashFunctionDigest digest;
};
#ifndef __cplusplus
typedef struct _hashFunction hashFunction;
#endif
/*
* You can use the following functions to find hash functions implemented by
* the library:
*
* hashFunctionCount returns the number of hash functions available.
*
* hashFunctionGet returns the hash function with a given index (starting
* at zero, up to hashFunctionCount() - 1), or NULL if the index was out of
* bounds.
*
* hashFunctionFind returns the hash function with the given name, or
* NULL if no hash function exists with that name.
*/
#ifdef __cplusplus
extern "C" {
#endif
BEECRYPTAPI
int hashFunctionCount(void);
BEECRYPTAPI
const hashFunction* hashFunctionGet(int);
BEECRYPTAPI
const hashFunction* hashFunctionFind(const char*);
BEECRYPTAPI
const hashFunction* hashFunctionDefault(void);
#ifdef __cplusplus
}
#endif
/*
* The struct 'hashFunctionContext' is used to contain both the functional
* part (the hashFunction), and its parameters.
*/
#ifdef __cplusplus
struct BEECRYPTAPI hashFunctionContext
#else
struct _hashFunctionContext
#endif
{
const hashFunction* algo;
hashFunctionParam* param;
#ifdef __cplusplus
hashFunctionContext();
hashFunctionContext(const hashFunction*);
~hashFunctionContext();
#endif
};
#ifndef __cplusplus
typedef struct _hashFunctionContext hashFunctionContext;
#endif
/*
* The following functions can be used to initialize and free a
* hashFunctionContext. Initializing will allocate a buffer of the size
* required by the hashFunction, freeing will deallocate that buffer.
*/
#ifdef __cplusplus
extern "C" {
#endif
BEECRYPTAPI
int hashFunctionContextInit(hashFunctionContext*, const hashFunction*);
BEECRYPTAPI
int hashFunctionContextFree(hashFunctionContext*);
BEECRYPTAPI
int hashFunctionContextReset(hashFunctionContext*);
BEECRYPTAPI
int hashFunctionContextUpdate(hashFunctionContext*, const byte*, size_t);
BEECRYPTAPI
int hashFunctionContextUpdateMC(hashFunctionContext*, const memchunk*);
BEECRYPTAPI
int hashFunctionContextUpdateMP(hashFunctionContext*, const mpnumber*);
BEECRYPTAPI
int hashFunctionContextDigest(hashFunctionContext*, byte*);
BEECRYPTAPI
int hashFunctionContextDigestMP(hashFunctionContext*, mpnumber*);
BEECRYPTAPI
int hashFunctionContextDigestMatch(hashFunctionContext*, const mpnumber*);
#ifdef __cplusplus
}
#endif
/*
* Keyed Hash Functions, a.k.a. Message Authentication Codes
*/
/*!\typedef void keyedHashFunctionParam
* \ingroup HMAC_m
*/
typedef void keyedHashFunctionParam;
typedef int (*keyedHashFunctionSetup )(keyedHashFunctionParam*, const byte*, size_t);
typedef int (*keyedHashFunctionReset )(keyedHashFunctionParam*);
typedef int (*keyedHashFunctionUpdate )(keyedHashFunctionParam*, const byte*, size_t);
typedef int (*keyedHashFunctionDigest )(keyedHashFunctionParam*, byte*);
/*
* The struct 'keyedHashFunction' holds information and pointers to code
* specific to each keyed hash function. Specific keyed hash functions MAY be
* written to be multithread-safe.
*
* The struct field 'keybitsmin' contains the minimum number of bits a key
* must contains, 'keybitsmax' the maximum number of bits a key may contain,
* 'keybitsinc', the increment in bits that may be used between min and max.
*
* NOTE: data must be at least have a bytesize of 'digestsize' as described
* in the keyedHashFunction struct.
* NOTE: for safety reasons, after calling digest, each specific implementation
* MUST reset itself so that previous values in the parameters are erased.
*/
#ifdef __cplusplus
struct BEECRYPTAPI keyedHashFunction
#else
struct _keyedHashFunction
#endif
{
const char* name;
const size_t paramsize; /* in bytes */
const size_t blocksize; /* in bytes */
const size_t digestsize; /* in bytes */
const size_t keybitsmin; /* in bits */
const size_t keybitsmax; /* in bits */
const size_t keybitsinc; /* in bits */
const keyedHashFunctionSetup setup;
const keyedHashFunctionReset reset;
const keyedHashFunctionUpdate update;
const keyedHashFunctionDigest digest;
};
#ifndef __cplusplus
typedef struct _keyedHashFunction keyedHashFunction;
#endif
/*
* You can use the following functions to find keyed hash functions implemented
* by the library:
*
* keyedHashFunctionCount returns the number of keyed hash functions available.
*
* keyedHashFunctionGet returns the keyed hash function with a given index
* (starting at zero, up to keyedHashFunctionCount() - 1), or NULL if the index
* was out of bounds.
*
* keyedHashFunctionFind returns the keyed hash function with the given name,
* or NULL if no keyed hash function exists with that name.
*/
#ifdef __cplusplus
extern "C" {
#endif
BEECRYPTAPI
int keyedHashFunctionCount(void);
BEECRYPTAPI
const keyedHashFunction* keyedHashFunctionGet(int);
BEECRYPTAPI
const keyedHashFunction* keyedHashFunctionFind(const char*);
BEECRYPTAPI
const keyedHashFunction* keyedHashFunctionDefault(void);
#ifdef __cplusplus
}
#endif
/*
* The struct 'keyedHashFunctionContext' is used to contain both the functional
* part (the keyedHashFunction), and its parameters.
*/
#ifdef __cplusplus
struct BEECRYPTAPI keyedHashFunctionContext
#else
struct _keyedHashFunctionContext
#endif
{
const keyedHashFunction* algo;
keyedHashFunctionParam* param;
#ifdef __cplusplus
keyedHashFunctionContext();
keyedHashFunctionContext(const keyedHashFunction*);
~keyedHashFunctionContext();
#endif
};
#ifndef __cplusplus
typedef struct _keyedHashFunctionContext keyedHashFunctionContext;
#endif
/*
* The following functions can be used to initialize and free a
* keyedHashFunctionContext. Initializing will allocate a buffer of the size
* required by the keyedHashFunction, freeing will deallocate that buffer.
*/
#ifdef __cplusplus
extern "C" {
#endif
BEECRYPTAPI
int keyedHashFunctionContextInit(keyedHashFunctionContext*, const keyedHashFunction*);
BEECRYPTAPI
int keyedHashFunctionContextFree(keyedHashFunctionContext*);
BEECRYPTAPI
int keyedHashFunctionContextSetup(keyedHashFunctionContext*, const byte*, size_t);
BEECRYPTAPI
int keyedHashFunctionContextReset(keyedHashFunctionContext*);
BEECRYPTAPI
int keyedHashFunctionContextUpdate(keyedHashFunctionContext*, const byte*, size_t);
BEECRYPTAPI
int keyedHashFunctionContextUpdateMC(keyedHashFunctionContext*, const memchunk*);
BEECRYPTAPI
int keyedHashFunctionContextUpdateMP(keyedHashFunctionContext*, const mpnumber*);
BEECRYPTAPI
int keyedHashFunctionContextDigest(keyedHashFunctionContext*, byte*);
BEECRYPTAPI
int keyedHashFunctionContextDigestMP(keyedHashFunctionContext*, mpnumber*);
BEECRYPTAPI
int keyedHashFunctionContextDigestMatch(keyedHashFunctionContext*, const mpnumber*);
#ifdef __cplusplus
}
#endif
/*
* Block ciphers
*/
/*!\enum cipherOperation
* \brief Specifies whether to perform encryption or decryption.
* \ingroup BC_m
*/
typedef enum
{
NOCRYPT,
ENCRYPT,
DECRYPT
} cipherOperation;
/*!\typedef void blockCipherParam
* \brief Placeholder type definition for blockcipher parameters.
* \sa aesParam, blowfishParam.
* \ingroup BC_m
*/
typedef void blockCipherParam;
/*!\brief Prototype definition for a setup function.
* \ingroup BC_m
*/
typedef int (*blockCipherSetup )(blockCipherParam*, const byte*, size_t, cipherOperation);
/*!\typedef int (*blockCipherSetIV)(blockCipherParam* bp, const byte* iv)
* \brief Prototype definition for an initialization vector setup function.
* \param bp The blockcipher's parameters.
* \param iv The blockciphers' IV value.
* \note iv length must be equal to the cipher's block size.
* \retval 0 on success.
* \retval -1 on failure.
* \ingroup BC_m
*/
typedef int (*blockCipherSetIV )(blockCipherParam*, const byte*);
/*!\typedef int (*blockCipherSetCTR)(blockCipherParam* bp, const byte* nivz, size_t counter)
* \brief Prototype definition for an initialization vector setup function.
* \param bp The blockcipher's parameters.
* \param nivz The concatenation of the Nonce, IV and padding Zero bytes.
* \param counter The blockciphers' counter value.
* \note nivz length must be equal to the cipher's block size.
* \retval 0 on success.
* \retval -1 on failure.
* \ingroup BC_m
*/
typedef int (*blockCipherSetCTR )(blockCipherParam*, const byte*, size_t);
/*!\typedef int (*blockCipherRawcrypt)(blockCipherParam* bp, uint32_t* dst, const uint32_t* src)
* \brief Prototype for a \e raw encryption or decryption function.
* \param bp The blockcipher's parameters.
* \param dst The ciphertext address; must be aligned on 32-bit boundary.
* \param src The cleartext address; must be aligned on 32-bit boundary.
* \retval 0 on success.
* \retval -1 on failure.
* \ingroup BC_m
*/
typedef int (*blockCipherRawcrypt)(blockCipherParam*, uint32_t*, const uint32_t*);
/*!\typedef int (*blockCipherModcrypt)(blockCipherParam* bp, uint32_t* dst, const uint32_t* src, unsigned int nblocks)
* \brief Prototype for a \e encryption or decryption function which operates
* on multiple blocks in a certain mode.
* \param bp The blockcipher's parameters.
* \param dst The ciphertext address; must be aligned on 32-bit boundary.
* \param src The cleartext address; must be aligned on 32-bit boundary.
* \param nblocks The number of blocks to process.
* \retval 0 on success.
* \retval -1 on failure.
* \ingroup BC_m
*/
typedef int (*blockCipherModcrypt)(blockCipherParam*, uint32_t*, const uint32_t*, unsigned int);
typedef uint32_t* (*blockCipherFeedback)(blockCipherParam*);
typedef struct
{
const blockCipherRawcrypt encrypt;
const blockCipherRawcrypt decrypt;
} blockCipherRaw;
typedef struct
{
const blockCipherModcrypt encrypt;
const blockCipherModcrypt decrypt;
} blockCipherMode;
/*!\brief Holds information and pointers to code specific to each cipher.
*
* Specific block ciphers \e may be written to be multithread-safe.
*
* \ingroup BC_m
*/
#ifdef __cplusplus
struct BEECRYPTAPI blockCipher
#else
struct _blockCipher
#endif
{
/*!\var name
* \brief The blockcipher's name.
*/
const char* name;
/*!\var paramsize
* \brief The size of the parameters required by this cipher, in bytes.
*/
const size_t paramsize;
/*!\var blocksize
* \brief The size of one block of data, in bytes.
*/
const size_t blocksize;
/*!\var keybitsmin
* \brief The minimum number of key bits.
*/
const size_t keybitsmin;
/*!\var keybitsmax
* \brief The maximum number of key bits.
*/
const size_t keybitsmax;
/*!\var keybitsinc
* \brief The allowed increment in key bits between min and max.
* \see keybitsmin and keybitsmax.
*/
const size_t keybitsinc;
/*!\var setup
* \brief Pointer to the cipher's setup function.
*/
const blockCipherSetup setup;
/*!\var setiv
* \brief Pointer to the cipher's initialization vector setup function.
*/
const blockCipherSetIV setiv;
/*!\var setctr
* \brief Pointer to the cipher's ctr setup function.
*/
const blockCipherSetCTR setctr;
/*!\var getfb
* \brief Pointer to the cipher's feedback-returning function.
*/
const blockCipherFeedback getfb;
/*!\var raw
* \brief The cipher's raw functions.
*/
const blockCipherRaw raw;
/*!\var ecb
* \brief The cipher's ECB functions.
*/
const blockCipherMode ecb;
/*!\var cbc
* \brief The cipher's CBC functions.
*/
const blockCipherMode cbc;
/*!\var ctr
* \brief The cipher's CTR functions.
*/
const blockCipherMode ctr;
};
#ifndef __cplusplus
typedef struct _blockCipher blockCipher;
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*!\fn int blockCipherCount()
* \brief This function returns the number of blockciphers implemented
* by the library.
* \return The number of implemented blockciphers.
*/
BEECRYPTAPI
int blockCipherCount(void);
/*!\fn const blockCipher* blockCipherGet(int n)
* \brief This function returns the \a n -th blockcipher implemented by
* the library.
* \param n Index of the requested blockcipher; legal values are 0
* through blockCipherCount() - 1.
* \return A pointer to a blockcipher or null, if the index was out of
* range.
*/
BEECRYPTAPI
const blockCipher* blockCipherGet(int);
/*!\fn const blockCipher* blockCipherFind(const char* name)
* \brief This function returns the blockcipher specified by the given name.
* \param name Name of the requested blockcipher.
* \return A pointer to a blockcipher or null, if the name wasn't found.
*/
BEECRYPTAPI
const blockCipher* blockCipherFind(const char*);
/*!\fn const blockCipher* blockCipherDefault()
* \brief This functions returns the default blockcipher; the default value
* can be specified by setting environment variable BEECRYPT_CIPHER.
* \return A pointer to a blockcipher or null, in case an error occured.
*/
BEECRYPTAPI
const blockCipher* blockCipherDefault(void);
#ifdef __cplusplus
}
#endif
/*!\brief Holds a pointer to a blockcipher as well as its parameters.
* \warning A context can be used by only one thread at the same time.
* \ingroup BC_m
*/
#ifdef __cplusplus
struct BEECRYPTAPI blockCipherContext
#else
struct _blockCipherContext
#endif
{
/*!\var algo
* \brief Pointer to a blockCipher.
*/
const blockCipher* algo;
/*!\var param
* \brief Pointer to the parameters used by algo.
*/
blockCipherParam* param;
/*!\var op
*/
cipherOperation op;
#ifdef __cplusplus
blockCipherContext();
blockCipherContext(const blockCipher*);
~blockCipherContext();
#endif
};
#ifndef __cplusplus
typedef struct _blockCipherContext blockCipherContext;
#endif
/*
* The following functions can be used to initialize and free a
* blockCipherContext. Initializing will allocate a buffer of the size
* required by the blockCipher, freeing will deallocate that buffer.
*/
#ifdef __cplusplus
extern "C" {
#endif
BEECRYPTAPI
int blockCipherContextInit(blockCipherContext*, const blockCipher*);
BEECRYPTAPI
int blockCipherContextSetup(blockCipherContext*, const byte*, size_t, cipherOperation);
BEECRYPTAPI
int blockCipherContextSetIV(blockCipherContext*, const byte*);
BEECRYPTAPI
int blockCipherContextSetCTR(blockCipherContext*, const byte*, size_t);
BEECRYPTAPI
int blockCipherContextFree(blockCipherContext*);
BEECRYPTAPI
int blockCipherContextECB(blockCipherContext*, uint32_t*, const uint32_t*, int);
BEECRYPTAPI
int blockCipherContextCBC(blockCipherContext*, uint32_t*, const uint32_t*, int);
BEECRYPTAPI
int blockCipherContextCTR(blockCipherContext*, uint32_t*, const uint32_t*, int);
BEECRYPTAPI
int blockCipherContextValidKeylen(blockCipherContext*, size_t);
#ifdef __cplusplus
}
#endif
#endif
|