crypto/openssh/cipher.h

   1 /* $OpenBSD: cipher.h,v 1.46 2014/06/24 01:13:21 djm Exp $ */
   2
   3 /*
   4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   6  *                    All rights reserved
   7  *
   8  * As far as I am concerned, the code I have written for this software
   9  * can be used freely for any purpose.  Any derived versions of this
  10  * software must be clearly marked as such, and if the derived work is
  11  * incompatible with the protocol description in the RFC file, it must be
  12  * called by a name other than "ssh" or "Secure Shell".
  13  *
  14  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  28  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #ifndef CIPHER_H
  38 #define CIPHER_H
  39
  40 #include <sys/types.h>
  41 #include <openssl/evp.h>
  42 #include "cipher-chachapoly.h"
  43 #include "cipher-aesctr.h"
  44
  45 /*
  46  * Cipher types for SSH-1.  New types can be added, but old types should not
  47  * be removed for compatibility.  The maximum allowed value is 31.
  48  */
  49 #define SSH_CIPHER_SSH2         -3
  50 #define SSH_CIPHER_INVALID      -2      /* No valid cipher selected. */
  51 #define SSH_CIPHER_NOT_SET      -1      /* None selected (invalid number). */
  52 #define SSH_CIPHER_NONE         0       /* no encryption */
  53 #define SSH_CIPHER_IDEA         1       /* IDEA CFB */
  54 #define SSH_CIPHER_DES          2       /* DES CBC */
  55 #define SSH_CIPHER_3DES         3       /* 3DES CBC */
  56 #define SSH_CIPHER_BROKEN_TSS   4       /* TRI's Simple Stream encryption CBC */
  57 #define SSH_CIPHER_BROKEN_RC4   5       /* Alleged RC4 */
  58 #define SSH_CIPHER_BLOWFISH     6
  59 #define SSH_CIPHER_RESERVED     7
  60 #define SSH_CIPHER_MAX          31
  61
  62 #define CIPHER_ENCRYPT          1
  63 #define CIPHER_DECRYPT          0
  64
  65 struct sshcipher;
  66 struct sshcipher_ctx {
  67         int     plaintext;
  68         int     encrypt;
  69         EVP_CIPHER_CTX evp;
  70         struct chachapoly_ctx cp_ctx; /* XXX union with evp? */
  71         struct aesctr_ctx ac_ctx; /* XXX union with evp? */
  72         const struct sshcipher *cipher;
  73 };
  74
  75 typedef struct sshcipher Cipher ;
  76 typedef struct sshcipher_ctx CipherContext ;
  77
  78 void ssh_aes_ctr_thread_destroy(EVP_CIPHER_CTX *ctx); // defined in cipher-ctr-mt.c
  79 void ssh_aes_ctr_thread_reconstruction(EVP_CIPHER_CTX *ctx);
  80
  81 u_int    cipher_mask_ssh1(int);
  82 struct sshcipher *cipher_by_name(const char *);
  83 const struct sshcipher *cipher_by_number(int);
  84 int      cipher_number(const char *);
  85 char    *cipher_name(int);
  86 int      ciphers_valid(const char *);
  87 char    *cipher_alg_list(char, int);
  88 int      cipher_init(struct sshcipher_ctx *, const struct sshcipher *,
  89     const u_char *, u_int, const u_char *, u_int, int);
  90 const char* cipher_warning_message(const struct sshcipher_ctx *);
  91 int      cipher_crypt(struct sshcipher_ctx *, u_int, u_char *, const u_char *,
  92     u_int, u_int, u_int);
  93 int      cipher_get_length(struct sshcipher_ctx *, u_int *, u_int,
  94     const u_char *, u_int);
  95 int      cipher_cleanup(struct sshcipher_ctx *);
  96 int      cipher_set_key_string(struct sshcipher_ctx *, const struct sshcipher *,
  97     const char *, int);
  98 u_int    cipher_blocksize(const struct sshcipher *);
  99 u_int    cipher_keylen(const struct sshcipher *);
 100 u_int    cipher_seclen(const struct sshcipher *);
 101 u_int    cipher_authlen(const struct sshcipher *);
 102 u_int    cipher_ivlen(const struct sshcipher *);
 103 u_int    cipher_is_cbc(const struct sshcipher *);
 104 void     cipher_reset_multithreaded(void);
 105 char    *cipher_return_name(const struct sshcipher *);
 106
 107 u_int    cipher_get_number(const struct sshcipher *);
 108 int      cipher_get_keyiv(struct sshcipher_ctx *, u_char *, u_int);
 109 int      cipher_set_keyiv(struct sshcipher_ctx *, const u_char *);
 110 int      cipher_get_keyiv_len(const struct sshcipher_ctx *);
 111 int      cipher_get_keycontext(const struct sshcipher_ctx *, u_char *);
 112 void     cipher_set_keycontext(struct sshcipher_ctx *, const u_char *);
 113 #endif                          /* CIPHER_H */