[thirdparty/openssl.git] / include / openssl / des.h

/*
 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#ifndef OPENSSL_DES_H
# define OPENSSL_DES_H
# pragma once

# include <openssl/macros.h>
# ifndef OPENSSL_NO_DEPRECATED_3_0
#  define HEADER_DES_H
# endif

# include <openssl/opensslconf.h>

# ifndef OPENSSL_NO_DES
#  ifdef  __cplusplus
extern "C" {
#  endif
#  include <openssl/e_os2.h>

#  ifndef OPENSSL_NO_DEPRECATED_3_0
typedef unsigned int DES_LONG;

#   ifdef OPENSSL_BUILD_SHLIBCRYPTO
#    undef OPENSSL_EXTERN
#    define OPENSSL_EXTERN OPENSSL_EXPORT
#   endif

typedef unsigned char DES_cblock[8];
typedef /* const */ unsigned char const_DES_cblock[8];
/*
 * With "const", gcc 2.8.1 on Solaris thinks that DES_cblock * and
 * const_DES_cblock * are incompatible pointer types.
 */

typedef struct DES_ks {
    union {
        DES_cblock cblock;
        /*
         * make sure things are correct size on machines with 8 byte longs
         */
        DES_LONG deslong[2];
    } ks[16];
} DES_key_schedule;

#   define DES_KEY_SZ      (sizeof(DES_cblock))
#   define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))

#   define DES_ENCRYPT     1
#   define DES_DECRYPT     0

#   define DES_CBC_MODE    0
#   define DES_PCBC_MODE   1

#   define DES_ecb2_encrypt(i,o,k1,k2,e) \
        DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))

#   define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
        DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))

#   define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
        DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))

#   define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
        DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))

#   define DES_fixup_key_parity DES_set_odd_parity
#  endif
#  ifndef OPENSSL_NO_DEPRECATED_3_0
OSSL_DEPRECATEDIN_3_0 const char *DES_options(void);
OSSL_DEPRECATEDIN_3_0
void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output,
                      DES_key_schedule *ks1, DES_key_schedule *ks2,
                      DES_key_schedule *ks3, int enc);
OSSL_DEPRECATEDIN_3_0
DES_LONG DES_cbc_cksum(const unsigned char *input, DES_cblock *output,
                       long length, DES_key_schedule *schedule,
                       const_DES_cblock *ivec);
#  endif
/* DES_cbc_encrypt does not update the IV!  Use DES_ncbc_encrypt instead. */
#  ifndef OPENSSL_NO_DEPRECATED_3_0
OSSL_DEPRECATEDIN_3_0
void DES_cbc_encrypt(const unsigned char *input, unsigned char *output,
                     long length, DES_key_schedule *schedule, DES_cblock *ivec,
                     int enc);
OSSL_DEPRECATEDIN_3_0
void DES_ncbc_encrypt(const unsigned char *input, unsigned char *output,
                      long length, DES_key_schedule *schedule, DES_cblock *ivec,
                      int enc);
OSSL_DEPRECATEDIN_3_0
void DES_xcbc_encrypt(const unsigned char *input, unsigned char *output,
                      long length, DES_key_schedule *schedule, DES_cblock *ivec,
                      const_DES_cblock *inw, const_DES_cblock *outw, int enc);
OSSL_DEPRECATEDIN_3_0
void DES_cfb_encrypt(const unsigned char *in, unsigned char *out, int numbits,
                     long length, DES_key_schedule *schedule, DES_cblock *ivec,
                     int enc);
OSSL_DEPRECATEDIN_3_0
void DES_ecb_encrypt(const_DES_cblock *input, DES_cblock *output,
                     DES_key_schedule *ks, int enc);
#  endif

/*
 * This is the DES encryption function that gets called by just about every
 * other DES routine in the library.  You should not use this function except
 * to implement 'modes' of DES.  I say this because the functions that call
 * this routine do the conversion from 'char *' to long, and this needs to be
 * done to make sure 'non-aligned' memory access do not occur.  The
 * characters are loaded 'little endian'. Data is a pointer to 2 unsigned
 * long's and ks is the DES_key_schedule to use.  enc, is non zero specifies
 * encryption, zero if decryption.
 */
#  ifndef OPENSSL_NO_DEPRECATED_3_0
OSSL_DEPRECATEDIN_3_0
void DES_encrypt1(DES_LONG *data, DES_key_schedule *ks, int enc);
#  endif

/*
 * This functions is the same as DES_encrypt1() except that the DES initial
 * permutation (IP) and final permutation (FP) have been left out.  As for
 * DES_encrypt1(), you should not use this function. It is used by the
 * routines in the library that implement triple DES. IP() DES_encrypt2()
 * DES_encrypt2() DES_encrypt2() FP() is the same as DES_encrypt1()
 * DES_encrypt1() DES_encrypt1() except faster :-).
 */
#  ifndef OPENSSL_NO_DEPRECATED_3_0
OSSL_DEPRECATEDIN_3_0
void DES_encrypt2(DES_LONG *data, DES_key_schedule *ks, int enc);
OSSL_DEPRECATEDIN_3_0
void DES_encrypt3(DES_LONG *data, DES_key_schedule *ks1, DES_key_schedule *ks2,
                  DES_key_schedule *ks3);
OSSL_DEPRECATEDIN_3_0
void DES_decrypt3(DES_LONG *data, DES_key_schedule *ks1, DES_key_schedule *ks2,
                  DES_key_schedule *ks3);
OSSL_DEPRECATEDIN_3_0
void DES_ede3_cbc_encrypt(const unsigned char *input, unsigned char *output,
                          long length, DES_key_schedule *ks1,
                          DES_key_schedule *ks2, DES_key_schedule *ks3,
                          DES_cblock *ivec, int enc);
OSSL_DEPRECATEDIN_3_0
void DES_ede3_cfb64_encrypt(const unsigned char *in, unsigned char *out,
                            long length, DES_key_schedule *ks1,
                            DES_key_schedule *ks2, DES_key_schedule *ks3,
                            DES_cblock *ivec, int *num, int enc);
OSSL_DEPRECATEDIN_3_0
void DES_ede3_cfb_encrypt(const unsigned char *in, unsigned char *out,
                          int numbits, long length, DES_key_schedule *ks1,
                          DES_key_schedule *ks2, DES_key_schedule *ks3,
                          DES_cblock *ivec, int enc);
OSSL_DEPRECATEDIN_3_0
void DES_ede3_ofb64_encrypt(const unsigned char *in, unsigned char *out,
                            long length, DES_key_schedule *ks1,
                            DES_key_schedule *ks2, DES_key_schedule *ks3,
                            DES_cblock *ivec, int *num);
OSSL_DEPRECATEDIN_3_0
char *DES_fcrypt(const char *buf, const char *salt, char *ret);
OSSL_DEPRECATEDIN_3_0
char *DES_crypt(const char *buf, const char *salt);
OSSL_DEPRECATEDIN_3_0
void DES_ofb_encrypt(const unsigned char *in, unsigned char *out, int numbits,
                     long length, DES_key_schedule *schedule, DES_cblock *ivec);
OSSL_DEPRECATEDIN_3_0
void DES_pcbc_encrypt(const unsigned char *input, unsigned char *output,
                      long length, DES_key_schedule *schedule,
                      DES_cblock *ivec, int enc);
OSSL_DEPRECATEDIN_3_0
DES_LONG DES_quad_cksum(const unsigned char *input, DES_cblock output[],
                        long length, int out_count, DES_cblock *seed);
OSSL_DEPRECATEDIN_3_0 int DES_random_key(DES_cblock *ret);
OSSL_DEPRECATEDIN_3_0 void DES_set_odd_parity(DES_cblock *key);
OSSL_DEPRECATEDIN_3_0 int DES_check_key_parity(const_DES_cblock *key);
OSSL_DEPRECATEDIN_3_0 int DES_is_weak_key(const_DES_cblock *key);
#  endif
/*
 * DES_set_key (= set_key = DES_key_sched = key_sched) calls
 * DES_set_key_checked
 */
#  ifndef OPENSSL_NO_DEPRECATED_3_0
OSSL_DEPRECATEDIN_3_0
int DES_set_key(const_DES_cblock *key, DES_key_schedule *schedule);
OSSL_DEPRECATEDIN_3_0
int DES_key_sched(const_DES_cblock *key, DES_key_schedule *schedule);
OSSL_DEPRECATEDIN_3_0
int DES_set_key_checked(const_DES_cblock *key, DES_key_schedule *schedule);
OSSL_DEPRECATEDIN_3_0
void DES_set_key_unchecked(const_DES_cblock *key, DES_key_schedule *schedule);
OSSL_DEPRECATEDIN_3_0 void DES_string_to_key(const char *str, DES_cblock *key);
OSSL_DEPRECATEDIN_3_0
void DES_string_to_2keys(const char *str, DES_cblock *key1, DES_cblock *key2);
OSSL_DEPRECATEDIN_3_0
void DES_cfb64_encrypt(const unsigned char *in, unsigned char *out,
                       long length, DES_key_schedule *schedule,
                       DES_cblock *ivec, int *num, int enc);
OSSL_DEPRECATEDIN_3_0
void DES_ofb64_encrypt(const unsigned char *in, unsigned char *out,
                       long length, DES_key_schedule *schedule,
                       DES_cblock *ivec, int *num);
#  endif

#  ifdef  __cplusplus
}
#  endif
# endif

#endif
Commit	Line	Data
21dcbebc	1	/*
33388b44	2	* Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
d02b48c6	3	*
48f4ad77	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc RS	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
d02b48c6 RE	8	*/
d02b48c6 RE	9
ae4186b0 DMSP	10	#ifndef OPENSSL_DES_H
ae4186b0 DMSP	11	# define OPENSSL_DES_H
d86167ec DMSP	12	# pragma once
	13
	14	# include <openssl/macros.h>
936c2b9e	15	# ifndef OPENSSL_NO_DEPRECATED_3_0
d86167ec DMSP	16	# define HEADER_DES_H
d86167ec DMSP	17	# endif
d02b48c6	18
3c27208f	19	# include <openssl/opensslconf.h>
0f387945	20
3c27208f	21	# ifndef OPENSSL_NO_DES
f6edde4f	22	# ifdef __cplusplus
3c27208f	23	extern "C" {
f6edde4f P	24	# endif
f6edde4f P	25	# include <openssl/e_os2.h>
f5d7a031	26
c6fec81b	27	# ifndef OPENSSL_NO_DEPRECATED_3_0
3e9e810f	28	typedef unsigned int DES_LONG;
bdb1d0c2	29
c6fec81b P	30	# ifdef OPENSSL_BUILD_SHLIBCRYPTO
	31	# undef OPENSSL_EXTERN
	32	# define OPENSSL_EXTERN OPENSSL_EXPORT
	33	# endif
26da3e65	34
c2e4f17c RL	35	typedef unsigned char DES_cblock[8];
c2e4f17c RL	36	typedef /* const */ unsigned char const_DES_cblock[8];
0f113f3e MC	37	/*
	38	* With "const", gcc 2.8.1 on Solaris thinks that DES_cblock * and
	39	* const_DES_cblock * are incompatible pointer types.
	40	*/
	41
	42	typedef struct DES_ks {
	43	union {
	44	DES_cblock cblock;
	45	/*
	46	* make sure things are correct size on machines with 8 byte longs
	47	*/
	48	DES_LONG deslong[2];
	49	} ks[16];
	50	} DES_key_schedule;
	51
c6fec81b P	52	# define DES_KEY_SZ (sizeof(DES_cblock))
c6fec81b P	53	# define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
d02b48c6	54
c6fec81b P	55	# define DES_ENCRYPT 1
c6fec81b P	56	# define DES_DECRYPT 0
d02b48c6	57
c6fec81b P	58	# define DES_CBC_MODE 0
c6fec81b P	59	# define DES_PCBC_MODE 1
d02b48c6	60
c6fec81b	61	# define DES_ecb2_encrypt(i,o,k1,k2,e) \
0f113f3e	62	DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
c2e4f17c	63
c6fec81b	64	# define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
0f113f3e	65	DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
c2e4f17c	66
c6fec81b	67	# define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
0f113f3e	68	DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
c2e4f17c	69
c6fec81b	70	# define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
0f113f3e	71	DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
c2e4f17c	72
c6fec81b P	73	# define DES_fixup_key_parity DES_set_odd_parity
c6fec81b P	74	# endif
27147678 RL	75	# ifndef OPENSSL_NO_DEPRECATED_3_0
	76	OSSL_DEPRECATEDIN_3_0 const char *DES_options(void);
	77	OSSL_DEPRECATEDIN_3_0
	78	void DES_ecb3_encrypt(const_DES_cblock input, DES_cblock output,
	79	DES_key_schedule ks1, DES_key_schedule ks2,
	80	DES_key_schedule *ks3, int enc);
	81	OSSL_DEPRECATEDIN_3_0
	82	DES_LONG DES_cbc_cksum(const unsigned char input, DES_cblock output,
	83	long length, DES_key_schedule *schedule,
	84	const_DES_cblock *ivec);
	85	# endif
c2e4f17c	86	/* DES_cbc_encrypt does not update the IV! Use DES_ncbc_encrypt instead. */
27147678 RL	87	# ifndef OPENSSL_NO_DEPRECATED_3_0
	88	OSSL_DEPRECATEDIN_3_0
	89	void DES_cbc_encrypt(const unsigned char input, unsigned char output,
	90	long length, DES_key_schedule schedule, DES_cblock ivec,
	91	int enc);
	92	OSSL_DEPRECATEDIN_3_0
	93	void DES_ncbc_encrypt(const unsigned char input, unsigned char output,
	94	long length, DES_key_schedule schedule, DES_cblock ivec,
	95	int enc);
	96	OSSL_DEPRECATEDIN_3_0
	97	void DES_xcbc_encrypt(const unsigned char input, unsigned char output,
	98	long length, DES_key_schedule schedule, DES_cblock ivec,
	99	const_DES_cblock inw, const_DES_cblock outw, int enc);
	100	OSSL_DEPRECATEDIN_3_0
	101	void DES_cfb_encrypt(const unsigned char in, unsigned char out, int numbits,
	102	long length, DES_key_schedule schedule, DES_cblock ivec,
	103	int enc);
	104	OSSL_DEPRECATEDIN_3_0
	105	void DES_ecb_encrypt(const_DES_cblock input, DES_cblock output,
	106	DES_key_schedule *ks, int enc);
	107	# endif
0f113f3e MC	108
	109	/*
	110	* This is the DES encryption function that gets called by just about every
	111	* other DES routine in the library. You should not use this function except
	112	* to implement 'modes' of DES. I say this because the functions that call
	113	* this routine do the conversion from 'char *' to long, and this needs to be
	114	* done to make sure 'non-aligned' memory access do not occur. The
	115	* characters are loaded 'little endian'. Data is a pointer to 2 unsigned
	116	* long's and ks is the DES_key_schedule to use. enc, is non zero specifies
	117	* encryption, zero if decryption.
	118	*/
27147678 RL	119	# ifndef OPENSSL_NO_DEPRECATED_3_0
	120	OSSL_DEPRECATEDIN_3_0
	121	void DES_encrypt1(DES_LONG data, DES_key_schedule ks, int enc);
	122	# endif
0f113f3e MC	123
	124	/*
	125	* This functions is the same as DES_encrypt1() except that the DES initial
	126	* permutation (IP) and final permutation (FP) have been left out. As for
	127	* DES_encrypt1(), you should not use this function. It is used by the
	128	* routines in the library that implement triple DES. IP() DES_encrypt2()
	129	* DES_encrypt2() DES_encrypt2() FP() is the same as DES_encrypt1()
	130	* DES_encrypt1() DES_encrypt1() except faster :-).
	131	*/
27147678 RL	132	# ifndef OPENSSL_NO_DEPRECATED_3_0
	133	OSSL_DEPRECATEDIN_3_0
	134	void DES_encrypt2(DES_LONG data, DES_key_schedule ks, int enc);
	135	OSSL_DEPRECATEDIN_3_0
	136	void DES_encrypt3(DES_LONG data, DES_key_schedule ks1, DES_key_schedule *ks2,
	137	DES_key_schedule *ks3);
	138	OSSL_DEPRECATEDIN_3_0
	139	void DES_decrypt3(DES_LONG data, DES_key_schedule ks1, DES_key_schedule *ks2,
	140	DES_key_schedule *ks3);
	141	OSSL_DEPRECATEDIN_3_0
	142	void DES_ede3_cbc_encrypt(const unsigned char input, unsigned char output,
	143	long length, DES_key_schedule *ks1,
	144	DES_key_schedule ks2, DES_key_schedule ks3,
	145	DES_cblock *ivec, int enc);
	146	OSSL_DEPRECATEDIN_3_0
	147	void DES_ede3_cfb64_encrypt(const unsigned char in, unsigned char out,
	148	long length, DES_key_schedule *ks1,
	149	DES_key_schedule ks2, DES_key_schedule ks3,
	150	DES_cblock ivec, int num, int enc);
	151	OSSL_DEPRECATEDIN_3_0
	152	void DES_ede3_cfb_encrypt(const unsigned char in, unsigned char out,
	153	int numbits, long length, DES_key_schedule *ks1,
	154	DES_key_schedule ks2, DES_key_schedule ks3,
	155	DES_cblock *ivec, int enc);
	156	OSSL_DEPRECATEDIN_3_0
	157	void DES_ede3_ofb64_encrypt(const unsigned char in, unsigned char out,
	158	long length, DES_key_schedule *ks1,
	159	DES_key_schedule ks2, DES_key_schedule ks3,
	160	DES_cblock ivec, int num);
	161	OSSL_DEPRECATEDIN_3_0
	162	char DES_fcrypt(const char buf, const char salt, char ret);
	163	OSSL_DEPRECATEDIN_3_0
	164	char DES_crypt(const char buf, const char *salt);
	165	OSSL_DEPRECATEDIN_3_0
	166	void DES_ofb_encrypt(const unsigned char in, unsigned char out, int numbits,
	167	long length, DES_key_schedule schedule, DES_cblock ivec);
	168	OSSL_DEPRECATEDIN_3_0
	169	void DES_pcbc_encrypt(const unsigned char input, unsigned char output,
	170	long length, DES_key_schedule *schedule,
	171	DES_cblock *ivec, int enc);
	172	OSSL_DEPRECATEDIN_3_0
	173	DES_LONG DES_quad_cksum(const unsigned char *input, DES_cblock output[],
	174	long length, int out_count, DES_cblock *seed);
	175	OSSL_DEPRECATEDIN_3_0 int DES_random_key(DES_cblock *ret);
	176	OSSL_DEPRECATEDIN_3_0 void DES_set_odd_parity(DES_cblock *key);
	177	OSSL_DEPRECATEDIN_3_0 int DES_check_key_parity(const_DES_cblock *key);
	178	OSSL_DEPRECATEDIN_3_0 int DES_is_weak_key(const_DES_cblock *key);
	179	# endif
0f113f3e MC	180	/*
0f113f3e MC	181	* DES_set_key (= set_key = DES_key_sched = key_sched) calls
bd01733f	182	* DES_set_key_checked
0f113f3e	183	*/
27147678 RL	184	# ifndef OPENSSL_NO_DEPRECATED_3_0
	185	OSSL_DEPRECATEDIN_3_0
	186	int DES_set_key(const_DES_cblock key, DES_key_schedule schedule);
	187	OSSL_DEPRECATEDIN_3_0
	188	int DES_key_sched(const_DES_cblock key, DES_key_schedule schedule);
	189	OSSL_DEPRECATEDIN_3_0
	190	int DES_set_key_checked(const_DES_cblock key, DES_key_schedule schedule);
	191	OSSL_DEPRECATEDIN_3_0
	192	void DES_set_key_unchecked(const_DES_cblock key, DES_key_schedule schedule);
	193	OSSL_DEPRECATEDIN_3_0 void DES_string_to_key(const char str, DES_cblock key);
	194	OSSL_DEPRECATEDIN_3_0
	195	void DES_string_to_2keys(const char str, DES_cblock key1, DES_cblock *key2);
	196	OSSL_DEPRECATEDIN_3_0
	197	void DES_cfb64_encrypt(const unsigned char in, unsigned char out,
	198	long length, DES_key_schedule *schedule,
	199	DES_cblock ivec, int num, int enc);
	200	OSSL_DEPRECATEDIN_3_0
	201	void DES_ofb64_encrypt(const unsigned char in, unsigned char out,
	202	long length, DES_key_schedule *schedule,
	203	DES_cblock ivec, int num);
	204	# endif
37b7185b	205
f6edde4f	206	# ifdef __cplusplus
d02b48c6	207	}
f6edde4f	208	# endif
3c27208f	209	# endif
d02b48c6 RE	210
d02b48c6 RE	211	#endif