cipher.h

/* $OpenBSD: cipher.h,v 1.55 2020/01/23 10:24:29 dtucker Exp $ */

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 *
 * Copyright (c) 2000 Markus Friedl.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CIPHER_H
#define CIPHER_H

#include <sys/types.h>
#ifdef WITH_OPENSSL
#include <openssl/evp.h>
#endif
#include "cipher-chachapoly.h"
#include "cipher-aesctr.h"

#define CIPHER_ENCRYPT      1
#define CIPHER_DECRYPT      0

struct sshcipher {
    char    *name;
    u_int   block_size;
    u_int   key_len;
    u_int   iv_len;     /* defaults to block_size */
    u_int   auth_len;
    u_int   flags;
#define CFLAG_CBC       (1<<0)
#define CFLAG_CHACHAPOLY    (1<<1)
#define CFLAG_AESCTR        (1<<2)
#define CFLAG_NONE      (1<<3)
#define CFLAG_INTERNAL      CFLAG_NONE /* Don't use "none" for packets */
#ifdef WITH_OPENSSL
    const EVP_CIPHER    *(*evptype)(void);
#else
    void    *ignored;
#endif
};

struct sshcipher_ctx;

void ssh_aes_ctr_thread_destroy(EVP_CIPHER_CTX *ctx); // defined in cipher-ctr-mt.c
void ssh_aes_ctr_thread_reconstruction(EVP_CIPHER_CTX *ctx);
struct sshcipher *cipher_by_name(const char *);
const char *cipher_warning_message(const struct sshcipher_ctx *);
int  ciphers_valid(const char *);
char    *cipher_alg_list(char, int);
const char *compression_alg_list(int);
int  cipher_init(struct sshcipher_ctx **, const struct sshcipher *,
    const u_char *, u_int, const u_char *, u_int, int);
int  cipher_crypt(struct sshcipher_ctx *, u_int, u_char *, const u_char *,
    u_int, u_int, u_int);
int  cipher_get_length(struct sshcipher_ctx *, u_int *, u_int,
    const u_char *, u_int);
void     cipher_free(struct sshcipher_ctx *);
u_int    cipher_blocksize(const struct sshcipher *);
u_int    cipher_keylen(const struct sshcipher *);
u_int    cipher_seclen(const struct sshcipher *);
u_int    cipher_authlen(const struct sshcipher *);
u_int    cipher_ivlen(const struct sshcipher *);
u_int    cipher_is_cbc(const struct sshcipher *);
void     cipher_reset_multithreaded(void);
const char *cipher_ctx_name(const struct sshcipher_ctx *);

u_int    cipher_ctx_is_plaintext(struct sshcipher_ctx *);

int  cipher_get_keyiv(struct sshcipher_ctx *, u_char *, size_t);
int  cipher_set_keyiv(struct sshcipher_ctx *, const u_char *, size_t);
int  cipher_get_keyiv_len(const struct sshcipher_ctx *);

#endif              /* CIPHER_H */