runtime/kwalletd/backend/blockcipher.h

   1 /* This file is part of the KDE project
   2    Copyright (C) 2001 George Staikos <staikos@kde.org>
   3
   4    This library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public
   6    License as published by the Free Software Foundation; either
   7    version 2 of the License, or (at your option) any later version.
   8
   9    This library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public License
  15    along with this library; see the file COPYING.LIB.  If not, write to
  16    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17    Boston, MA 02110-1301, USA.
  18 */
  19
  20 #ifndef BLOCKCIPHER_H
  21 #define BLOCKCIPHER_H
  22
  23 /* @internal
  24  */
  25 class BlockCipher {
  26         public:
  27                 BlockCipher();
  28                 virtual ~BlockCipher();
  29
  30                 /*
  31                  *  Return the current blocksize in bytes.
  32                  */
  33                 int blockSize() const;
  34
  35                 /*
  36                  *  Set the encryption key to key.  Return true on success.
  37                  */
  38                 virtual bool setKey(void *key, int bitlength) = 0;
  39
  40                 /*
  41                  *  Get the required (or if it's variable, then the maximum) key
  42                  *  length for this cipher in bits.
  43                  */
  44                 virtual int keyLen() const = 0;
  45
  46                 /*
  47                  *  True if the key is of a variable length.  In this case,
  48                  *  getKeyLen() will return the maximum length.
  49                  */
  50                 virtual bool variableKeyLen() const = 0;
  51
  52                 /*
  53                  *  True if all settings are good and we are ready to encrypt.
  54                  */
  55                 virtual bool readyToGo() const = 0;
  56
  57                 /*
  58                  *  Encrypt the block.  Returns the number of bytes successfully
  59                  *  encrypted.  Can return -1 on error.
  60                  */
  61                 virtual int encrypt(void *block, int len) = 0;
  62
  63                 /*
  64                  *  Decrypt the block.  Returns as does encrypt();
  65                  */
  66                 virtual int decrypt(void *block, int len) = 0;
  67
  68         protected:
  69                 int _blksz;
  70                 int _keylen;   // in bits
  71 };
  72
  73 #endif // BLOCKCIPHER_H