mark all block comments that need format preserving so that
[openssl.git] / crypto / des / des_old.h
index 1af7189..33169ad 100644 (file)
@@ -1,15 +1,32 @@
 /* crypto/des/des_old.h -*- mode:C; c-file-style: "eay" -*- */
 
-/* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
+/*- 
+ * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
  *
  * The function names in here are deprecated and are only present to
- * provide an interface compatible with libdes.  OpenSSL now provides
- * functions where "des_" has been replaced with "DES_" in the names,
- * to make it possible to make incompatible changes that are needed
- * for C type security and other stuff.
+ * provide an interface compatible with openssl 0.9.6 and older as
+ * well as libdes.  OpenSSL now provides functions where "des_" has
+ * been replaced with "DES_" in the names, to make it possible to
+ * make incompatible changes that are needed for C type security and
+ * other stuff.
+ *
+ * This include files has two compatibility modes:
+ *
+ *   - If OPENSSL_DES_LIBDES_COMPATIBILITY is defined, you get an API
+ *     that is compatible with libdes and SSLeay.
+ *   - If OPENSSL_DES_LIBDES_COMPATIBILITY isn't defined, you get an
+ *     API that is compatible with OpenSSL 0.9.5x to 0.9.6x.
+ *
+ * Note that these modes break earlier snapshots of OpenSSL, where
+ * libdes compatibility was the only available mode or (later on) the
+ * prefered compatibility mode.  However, after much consideration
+ * (and more or less violent discussions with external parties), it
+ * was concluded that OpenSSL should be compatible with earlier versions
+ * of itself before anything else.  Also, in all honesty, libdes is
+ * an old beast that shouldn't really be used any more.
  *
  * Please consider starting to use the DES_ functions rather than the
- * des_ ones.  The des_ functions will dissapear completely before
+ * des_ ones.  The des_ functions will disappear completely before
  * OpenSSL 1.0!
  *
  * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
@@ -19,7 +36,7 @@
  * project 2001.
  */
 /* ====================================================================
- * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
+ * Copyright (c) 1998-2002 The OpenSSL Project.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  *
  */
 
-#ifndef HEADER_DES_OLD_H
-#define HEADER_DES_OLD_H
+#ifndef HEADER_DES_H
+#define HEADER_DES_H
+
+#include <openssl/e_os2.h>     /* OPENSSL_EXTERN, OPENSSL_NO_DES, DES_LONG */
 
 #ifdef OPENSSL_NO_DES
 #error DES is disabled.
 #endif
 
+#ifndef HEADER_NEW_DES_H
+#error You must include des.h, not des_old.h directly.
+#endif
+
 #ifdef _KERBEROS_DES_H
 #error <openssl/des_old.h> replaces <kerberos/des.h>.
 #endif
 
-#include <openssl/opensslconf.h> /* DES_LONG */
-#include <openssl/e_os2.h>     /* OPENSSL_EXTERN */
 #include <openssl/symhacks.h>
 
 #ifdef OPENSSL_BUILD_SHLIBCRYPTO
 extern "C" {
 #endif
 
+#ifdef _
+#undef _
+#endif
+
 typedef unsigned char _ossl_old_des_cblock[8];
 typedef struct _ossl_old_des_ks_struct
        {
        union   {
-               _ossl_old_des_des_cblock _;
+               _ossl_old_des_cblock _;
                /* make sure things are correct size on machines with
                 * 8 byte longs */
                DES_LONG pad[2];
                } ks;
        } _ossl_old_des_key_schedule[16];
 
-#ifdef OPENSSL_DES_PRE_0_9_7_COMPATIBILITY
+#ifndef OPENSSL_DES_LIBDES_COMPATIBILITY
 #define des_cblock DES_cblock
+#define const_des_cblock const_DES_cblock
 #define des_key_schedule DES_key_schedule
 #define des_ecb3_encrypt(i,o,k1,k2,k3,e)\
-       DES_ecb3_encrypt((i),(o),(k1),(k2),(k3),(e))
+       DES_ecb3_encrypt((i),(o),&(k1),&(k2),&(k3),(e))
 #define des_ede3_cbc_encrypt(i,o,l,k1,k2,k3,iv,e)\
-       DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(e))
+       DES_ede3_cbc_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv),(e))
+#define des_ede3_cbcm_encrypt(i,o,l,k1,k2,k3,iv1,iv2,e)\
+       DES_ede3_cbcm_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv1),(iv2),(e))
 #define des_ede3_cfb64_encrypt(i,o,l,k1,k2,k3,iv,n,e)\
-       DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(e))
+       DES_ede3_cfb64_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv),(n),(e))
 #define des_ede3_ofb64_encrypt(i,o,l,k1,k2,k3,iv,n)\
-       DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(n))
+       DES_ede3_ofb64_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv),(n))
 #define des_options()\
        DES_options()
 #define des_cbc_cksum(i,o,l,k,iv)\
-       DES_cbc_cksum((i),(o),(l),(k),(iv))
+       DES_cbc_cksum((i),(o),(l),&(k),(iv))
 #define des_cbc_encrypt(i,o,l,k,iv,e)\
-       DES_cbc_encrypt((i),(o),(l),(k),(iv),(e))
+       DES_cbc_encrypt((i),(o),(l),&(k),(iv),(e))
 #define des_ncbc_encrypt(i,o,l,k,iv,e)\
-       DES_ncbc_encrypt((i),(o),(l),(k),(iv),(e))
+       DES_ncbc_encrypt((i),(o),(l),&(k),(iv),(e))
 #define des_xcbc_encrypt(i,o,l,k,iv,inw,outw,e)\
-       DES_xcbc_encrypt((i),(o),(l),(k),(iv),(inw),(outw),(e))
-#define des_cfb_encrypt(i,o,l,k,iv,e)\
-       DES_cfb_encrypt((i),(o),(l),(k),(iv),(e))
+       DES_xcbc_encrypt((i),(o),(l),&(k),(iv),(inw),(outw),(e))
+#define des_cfb_encrypt(i,o,n,l,k,iv,e)\
+       DES_cfb_encrypt((i),(o),(n),(l),&(k),(iv),(e))
 #define des_ecb_encrypt(i,o,k,e)\
-       DES_ecb_encrypt((i),(o),(k),(e))
-#define des_encrypt(d,k,e)\
-       DES_encrypt((d),(k),(e))
+       DES_ecb_encrypt((i),(o),&(k),(e))
+#define des_encrypt1(d,k,e)\
+       DES_encrypt1((d),&(k),(e))
 #define des_encrypt2(d,k,e)\
-       DES_encrypt2((d),(k),(e))
+       DES_encrypt2((d),&(k),(e))
 #define des_encrypt3(d,k1,k2,k3)\
-       DES_encrypt3((d),(k1),(k2),(k3))
+       DES_encrypt3((d),&(k1),&(k2),&(k3))
 #define des_decrypt3(d,k1,k2,k3)\
-       DES_decrypt3((d),(k1),(k2),(k3))
+       DES_decrypt3((d),&(k1),&(k2),&(k3))
 #define des_xwhite_in2out(k,i,o)\
        DES_xwhite_in2out((k),(i),(o))
 #define des_enc_read(f,b,l,k,iv)\
-       DES_enc_read((f),(b),(l),(k),(iv))
+       DES_enc_read((f),(b),(l),&(k),(iv))
 #define des_enc_write(f,b,l,k,iv)\
-       DES_enc_write((f),(b),(l),(k),(iv))
+       DES_enc_write((f),(b),(l),&(k),(iv))
 #define des_fcrypt(b,s,r)\
        DES_fcrypt((b),(s),(r))
+#if 0
 #define des_crypt(b,s)\
        DES_crypt((b),(s))
+#if !defined(PERL5) && !defined(__FreeBSD__) && !defined(__OpenBSD__)
+#define crypt(b,s)\
+       DES_crypt((b),(s))
+#endif
+#endif
 #define des_ofb_encrypt(i,o,n,l,k,iv)\
-       DES_ofb_encrypt((i),(o),(n),(l),(k),(iv))
+       DES_ofb_encrypt((i),(o),(n),(l),&(k),(iv))
 #define des_pcbc_encrypt(i,o,l,k,iv,e)\
-       DES_pcbc_encrypt((i),(o),(l),(k),(iv),(e))
+       DES_pcbc_encrypt((i),(o),(l),&(k),(iv),(e))
 #define des_quad_cksum(i,o,l,c,s)\
        DES_quad_cksum((i),(o),(l),(c),(s))
 #define des_random_seed(k)\
-       DES_random_seed((k))
+       _ossl_096_des_random_seed((k))
 #define des_random_key(r)\
        DES_random_key((r))
 #define des_read_password(k,p,v) \
@@ -166,20 +200,26 @@ typedef struct _ossl_old_des_ks_struct
        DES_read_2passwords((k1),(k2),(p),(v))
 #define des_set_odd_parity(k)\
        DES_set_odd_parity((k))
+#define des_check_key_parity(k)\
+       DES_check_key_parity((k))
 #define des_is_weak_key(k)\
        DES_is_weak_key((k))
 #define des_set_key(k,ks)\
-       DES_set_key((k),(ks))
+       DES_set_key((k),&(ks))
 #define des_key_sched(k,ks)\
-       DES_key_sched((k),(ks))
+       DES_key_sched((k),&(ks))
+#define des_set_key_checked(k,ks)\
+       DES_set_key_checked((k),&(ks))
+#define des_set_key_unchecked(k,ks)\
+       DES_set_key_unchecked((k),&(ks))
 #define des_string_to_key(s,k)\
        DES_string_to_key((s),(k))
 #define des_string_to_2keys(s,k1,k2)\
        DES_string_to_2keys((s),(k1),(k2))
 #define des_cfb64_encrypt(i,o,l,ks,iv,n,e)\
-       DES_cfb64_encrypt((i),(o),(l),(ks),(iv),(n),(e))
+       DES_cfb64_encrypt((i),(o),(l),&(ks),(iv),(n),(e))
 #define des_ofb64_encrypt(i,o,l,ks,iv,n)\
-       DES_ofb64_encrypt((i),(o),(l),(ks),(iv),(n))
+       DES_ofb64_encrypt((i),(o),(l),&(ks),(iv),(n))
                
 
 #define des_ecb2_encrypt(i,o,k1,k2,e) \
@@ -206,7 +246,7 @@ typedef struct _ossl_old_des_ks_struct
 #define des_ede3_cbc_encrypt(i,o,l,k1,k2,k3,iv,e)\
        _ossl_old_des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(e))
 #define des_ede3_cfb64_encrypt(i,o,l,k1,k2,k3,iv,n,e)\
-       _ossl_old_des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(e))
+       _ossl_old_des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(n),(e))
 #define des_ede3_ofb64_encrypt(i,o,l,k1,k2,k3,iv,n)\
        _ossl_old_des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(n))
 #define des_options()\
@@ -219,8 +259,8 @@ typedef struct _ossl_old_des_ks_struct
        _ossl_old_des_ncbc_encrypt((i),(o),(l),(k),(iv),(e))
 #define des_xcbc_encrypt(i,o,l,k,iv,inw,outw,e)\
        _ossl_old_des_xcbc_encrypt((i),(o),(l),(k),(iv),(inw),(outw),(e))
-#define des_cfb_encrypt(i,o,l,k,iv,e)\
-       _ossl_old_des_cfb_encrypt((i),(o),(l),(k),(iv),(e))
+#define des_cfb_encrypt(i,o,n,l,k,iv,e)\
+       _ossl_old_des_cfb_encrypt((i),(o),(n),(l),(k),(iv),(e))
 #define des_ecb_encrypt(i,o,k,e)\
        _ossl_old_des_ecb_encrypt((i),(o),(k),(e))
 #define des_encrypt(d,k,e)\
@@ -241,8 +281,10 @@ typedef struct _ossl_old_des_ks_struct
        _ossl_old_des_fcrypt((b),(s),(r))
 #define des_crypt(b,s)\
        _ossl_old_des_crypt((b),(s))
+#if 0
 #define crypt(b,s)\
        _ossl_old_crypt((b),(s))
+#endif
 #define des_ofb_encrypt(i,o,n,l,k,iv)\
        _ossl_old_des_ofb_encrypt((i),(o),(n),(l),(k),(iv))
 #define des_pcbc_encrypt(i,o,l,k,iv,e)\
@@ -323,9 +365,10 @@ void _ossl_old_des_ede3_cfb64_encrypt(unsigned char *in, unsigned char *out,
 void _ossl_old_des_ede3_ofb64_encrypt(unsigned char *in, unsigned char *out,
        long length, _ossl_old_des_key_schedule ks1, _ossl_old_des_key_schedule ks2,
        _ossl_old_des_key_schedule ks3, _ossl_old_des_cblock *ivec, int *num);
-
+#if 0
 void _ossl_old_des_xwhite_in2out(_ossl_old_des_cblock (*des_key), _ossl_old_des_cblock (*in_white),
        _ossl_old_des_cblock (*out_white));
+#endif
 
 int _ossl_old_des_enc_read(int fd,char *buf,int len,_ossl_old_des_key_schedule sched,
        _ossl_old_des_cblock *iv);
@@ -333,7 +376,7 @@ int _ossl_old_des_enc_write(int fd,char *buf,int len,_ossl_old_des_key_schedule
        _ossl_old_des_cblock *iv);
 char *_ossl_old_des_fcrypt(const char *buf,const char *salt, char *ret);
 char *_ossl_old_des_crypt(const char *buf,const char *salt);
-#if !defined(PERL5) && !defined(__FreeBSD__) && !defined(NeXT)
+#if !defined(PERL5)
 char *_ossl_old_crypt(const char *buf,const char *salt);
 #endif
 void _ossl_old_des_ofb_encrypt(unsigned char *in,unsigned char *out,
@@ -358,6 +401,8 @@ void _ossl_old_des_cfb64_encrypt(unsigned char *in, unsigned char *out, long len
 void _ossl_old_des_ofb64_encrypt(unsigned char *in, unsigned char *out, long length,
        _ossl_old_des_key_schedule schedule, _ossl_old_des_cblock *ivec, int *num);
 
+void _ossl_096_des_random_seed(des_cblock *key);
+
 /* The following definitions provide compatibility with the MIT Kerberos
  * library. The _ossl_old_des_key_schedule structure is not binary compatible. */