]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - ssh.h
Add a key-length field to 'struct ssh_mac'.
[PuTTY.git] / ssh.h
1 #include <stdio.h>
2 #include <string.h>
3
4 #include "puttymem.h"
5 #include "tree234.h"
6 #include "network.h"
7 #include "int64.h"
8 #include "misc.h"
9
10 struct ssh_channel;
11 typedef struct ssh_tag *Ssh;
12
13 extern int sshfwd_write(struct ssh_channel *c, char *, int);
14 extern void sshfwd_write_eof(struct ssh_channel *c);
15 extern void sshfwd_unclean_close(struct ssh_channel *c, const char *err);
16 extern void sshfwd_unthrottle(struct ssh_channel *c, int bufsize);
17 Conf *sshfwd_get_conf(struct ssh_channel *c);
18 void sshfwd_x11_sharing_handover(struct ssh_channel *c,
19                                  void *share_cs, void *share_chan,
20                                  const char *peer_addr, int peer_port,
21                                  int endian, int protomajor, int protominor,
22                                  const void *initial_data, int initial_len);
23 void sshfwd_x11_is_local(struct ssh_channel *c);
24
25 extern Socket ssh_connection_sharing_init(const char *host, int port,
26                                           Conf *conf, Ssh ssh, void **state);
27 void share_got_pkt_from_server(void *ctx, int type,
28                                unsigned char *pkt, int pktlen);
29 void share_activate(void *state, const char *server_verstring);
30 void sharestate_free(void *state);
31 int share_ndownstreams(void *state);
32
33 void ssh_connshare_log(Ssh ssh, int event, const char *logtext,
34                        const char *ds_err, const char *us_err);
35 unsigned ssh_alloc_sharing_channel(Ssh ssh, void *sharing_ctx);
36 void ssh_delete_sharing_channel(Ssh ssh, unsigned localid);
37 int ssh_alloc_sharing_rportfwd(Ssh ssh, const char *shost, int sport,
38                                void *share_ctx);
39 void ssh_sharing_queue_global_request(Ssh ssh, void *share_ctx);
40 struct X11FakeAuth *ssh_sharing_add_x11_display(Ssh ssh, int authtype,
41                                                 void *share_cs,
42                                                 void *share_chan);
43 void ssh_sharing_remove_x11_display(Ssh ssh, struct X11FakeAuth *auth);
44 void ssh_send_packet_from_downstream(Ssh ssh, unsigned id, int type,
45                                      const void *pkt, int pktlen,
46                                      const char *additional_log_text);
47 void ssh_sharing_downstream_connected(Ssh ssh, unsigned id,
48                                       const char *peerinfo);
49 void ssh_sharing_downstream_disconnected(Ssh ssh, unsigned id);
50 void ssh_sharing_logf(Ssh ssh, unsigned id, const char *logfmt, ...);
51 int ssh_agent_forwarding_permitted(Ssh ssh);
52 void share_setup_x11_channel(void *csv, void *chanv,
53                              unsigned upstream_id, unsigned server_id,
54                              unsigned server_currwin, unsigned server_maxpkt,
55                              unsigned client_adjusted_window,
56                              const char *peer_addr, int peer_port, int endian,
57                              int protomajor, int protominor,
58                              const void *initial_data, int initial_len);
59
60 /*
61  * Useful thing.
62  */
63 #ifndef lenof
64 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
65 #endif
66
67 #define SSH_CIPHER_IDEA         1
68 #define SSH_CIPHER_DES          2
69 #define SSH_CIPHER_3DES         3
70 #define SSH_CIPHER_BLOWFISH     6
71
72 #ifdef MSCRYPTOAPI
73 #define APIEXTRA 8
74 #else
75 #define APIEXTRA 0
76 #endif
77
78 #ifndef BIGNUM_INTERNAL
79 typedef void *Bignum;
80 #endif
81
82 struct RSAKey {
83     int bits;
84     int bytes;
85 #ifdef MSCRYPTOAPI
86     unsigned long exponent;
87     unsigned char *modulus;
88 #else
89     Bignum modulus;
90     Bignum exponent;
91     Bignum private_exponent;
92     Bignum p;
93     Bignum q;
94     Bignum iqmp;
95 #endif
96     char *comment;
97 };
98
99 struct dss_key {
100     Bignum p, q, g, y, x;
101 };
102
103 struct ec_curve;
104
105 struct ec_point {
106     const struct ec_curve *curve;
107     Bignum x, y;
108     Bignum z;  /* Jacobian denominator */
109     unsigned char infinity;
110 };
111
112 void ec_point_free(struct ec_point *point);
113
114 /* Weierstrass form curve */
115 struct ec_wcurve
116 {
117     Bignum a, b, n;
118     struct ec_point G;
119 };
120
121 /* Montgomery form curve */
122 struct ec_mcurve
123 {
124     Bignum a, b;
125     struct ec_point G;
126 };
127
128 /* Edwards form curve */
129 struct ec_ecurve
130 {
131     Bignum l, d;
132     struct ec_point B;
133 };
134
135 struct ec_curve {
136     enum { EC_WEIERSTRASS, EC_MONTGOMERY, EC_EDWARDS } type;
137     /* 'name' is the identifier of the curve when it has to appear in
138      * wire protocol encodings, as it does in e.g. the public key and
139      * signature formats for NIST curves. Curves which do not format
140      * their keys or signatures in this way just have name==NULL.
141      *
142      * 'textname' is non-NULL for all curves, and is a human-readable
143      * identification suitable for putting in log messages. */
144     const char *name, *textname;
145     unsigned int fieldBits;
146     Bignum p;
147     union {
148         struct ec_wcurve w;
149         struct ec_mcurve m;
150         struct ec_ecurve e;
151     };
152 };
153
154 const struct ssh_signkey *ec_alg_by_oid(int len, const void *oid,
155                                         const struct ec_curve **curve);
156 const unsigned char *ec_alg_oid(const struct ssh_signkey *alg, int *oidlen);
157 const int ec_nist_alg_and_curve_by_bits(int bits,
158                                         const struct ec_curve **curve,
159                                         const struct ssh_signkey **alg);
160 const int ec_ed_alg_and_curve_by_bits(int bits,
161                                       const struct ec_curve **curve,
162                                       const struct ssh_signkey **alg);
163
164 struct ssh_signkey;
165
166 struct ec_key {
167     const struct ssh_signkey *signalg;
168     struct ec_point publicKey;
169     Bignum privateKey;
170 };
171
172 struct ec_point *ec_public(const Bignum privateKey, const struct ec_curve *curve);
173
174 int makekey(const unsigned char *data, int len, struct RSAKey *result,
175             const unsigned char **keystr, int order);
176 int makeprivate(const unsigned char *data, int len, struct RSAKey *result);
177 int rsaencrypt(unsigned char *data, int length, struct RSAKey *key);
178 Bignum rsadecrypt(Bignum input, struct RSAKey *key);
179 void rsasign(unsigned char *data, int length, struct RSAKey *key);
180 void rsasanitise(struct RSAKey *key);
181 int rsastr_len(struct RSAKey *key);
182 void rsastr_fmt(char *str, struct RSAKey *key);
183 void rsa_fingerprint(char *str, int len, struct RSAKey *key);
184 int rsa_verify(struct RSAKey *key);
185 unsigned char *rsa_public_blob(struct RSAKey *key, int *len);
186 int rsa_public_blob_len(void *data, int maxlen);
187 void freersakey(struct RSAKey *key);
188
189 #ifndef PUTTY_UINT32_DEFINED
190 /* This makes assumptions about the int type. */
191 typedef unsigned int uint32;
192 #define PUTTY_UINT32_DEFINED
193 #endif
194 typedef uint32 word32;
195
196 unsigned long crc32_compute(const void *s, size_t len);
197 unsigned long crc32_update(unsigned long crc_input, const void *s, size_t len);
198
199 /* SSH CRC compensation attack detector */
200 void *crcda_make_context(void);
201 void crcda_free_context(void *handle);
202 int detect_attack(void *handle, unsigned char *buf, uint32 len,
203                   unsigned char *IV);
204
205 /*
206  * SSH2 RSA key exchange functions
207  */
208 struct ssh_hash;
209 void *ssh_rsakex_newkey(char *data, int len);
210 void ssh_rsakex_freekey(void *key);
211 int ssh_rsakex_klen(void *key);
212 void ssh_rsakex_encrypt(const struct ssh_hash *h, unsigned char *in, int inlen,
213                         unsigned char *out, int outlen,
214                         void *key);
215
216 /*
217  * SSH2 ECDH key exchange functions
218  */
219 struct ssh_kex;
220 const char *ssh_ecdhkex_curve_textname(const struct ssh_kex *kex);
221 void *ssh_ecdhkex_newkey(const struct ssh_kex *kex);
222 void ssh_ecdhkex_freekey(void *key);
223 char *ssh_ecdhkex_getpublic(void *key, int *len);
224 Bignum ssh_ecdhkex_getkey(void *key, char *remoteKey, int remoteKeyLen);
225
226 /*
227  * Helper function for k generation in DSA, reused in ECDSA
228  */
229 Bignum *dss_gen_k(const char *id_string, Bignum modulus, Bignum private_key,
230                   unsigned char *digest, int digest_len);
231
232 typedef struct {
233     uint32 h[4];
234 } MD5_Core_State;
235
236 struct MD5Context {
237 #ifdef MSCRYPTOAPI
238     unsigned long hHash;
239 #else
240     MD5_Core_State core;
241     unsigned char block[64];
242     int blkused;
243     uint32 lenhi, lenlo;
244 #endif
245 };
246
247 void MD5Init(struct MD5Context *context);
248 void MD5Update(struct MD5Context *context, unsigned char const *buf,
249                unsigned len);
250 void MD5Final(unsigned char digest[16], struct MD5Context *context);
251 void MD5Simple(void const *p, unsigned len, unsigned char output[16]);
252
253 void *hmacmd5_make_context(void *);
254 void hmacmd5_free_context(void *handle);
255 void hmacmd5_key(void *handle, void const *key, int len);
256 void hmacmd5_do_hmac(void *handle, unsigned char const *blk, int len,
257                      unsigned char *hmac);
258
259 typedef struct {
260     uint32 h[5];
261     unsigned char block[64];
262     int blkused;
263     uint32 lenhi, lenlo;
264 } SHA_State;
265 void SHA_Init(SHA_State * s);
266 void SHA_Bytes(SHA_State * s, const void *p, int len);
267 void SHA_Final(SHA_State * s, unsigned char *output);
268 void SHA_Simple(const void *p, int len, unsigned char *output);
269
270 void hmac_sha1_simple(void *key, int keylen, void *data, int datalen,
271                       unsigned char *output);
272 typedef struct {
273     uint32 h[8];
274     unsigned char block[64];
275     int blkused;
276     uint32 lenhi, lenlo;
277 } SHA256_State;
278 void SHA256_Init(SHA256_State * s);
279 void SHA256_Bytes(SHA256_State * s, const void *p, int len);
280 void SHA256_Final(SHA256_State * s, unsigned char *output);
281 void SHA256_Simple(const void *p, int len, unsigned char *output);
282
283 typedef struct {
284     uint64 h[8];
285     unsigned char block[128];
286     int blkused;
287     uint32 len[4];
288 } SHA512_State;
289 #define SHA384_State SHA512_State
290 void SHA512_Init(SHA512_State * s);
291 void SHA512_Bytes(SHA512_State * s, const void *p, int len);
292 void SHA512_Final(SHA512_State * s, unsigned char *output);
293 void SHA512_Simple(const void *p, int len, unsigned char *output);
294 void SHA384_Init(SHA384_State * s);
295 #define SHA384_Bytes(s, p, len) SHA512_Bytes(s, p, len)
296 void SHA384_Final(SHA384_State * s, unsigned char *output);
297 void SHA384_Simple(const void *p, int len, unsigned char *output);
298
299 struct ssh_mac;
300 struct ssh_cipher {
301     void *(*make_context)(void);
302     void (*free_context)(void *);
303     void (*sesskey) (void *, unsigned char *key);       /* for SSH-1 */
304     void (*encrypt) (void *, unsigned char *blk, int len);
305     void (*decrypt) (void *, unsigned char *blk, int len);
306     int blksize;
307     const char *text_name;
308 };
309
310 struct ssh2_cipher {
311     void *(*make_context)(void);
312     void (*free_context)(void *);
313     void (*setiv) (void *, unsigned char *key); /* for SSH-2 */
314     void (*setkey) (void *, unsigned char *key);/* for SSH-2 */
315     void (*encrypt) (void *, unsigned char *blk, int len);
316     void (*decrypt) (void *, unsigned char *blk, int len);
317     /* Ignored unless SSH_CIPHER_SEPARATE_LENGTH flag set */
318     void (*encrypt_length) (void *, unsigned char *blk, int len, unsigned long seq);
319     void (*decrypt_length) (void *, unsigned char *blk, int len, unsigned long seq);
320     const char *name;
321     int blksize;
322     int keylen;
323     unsigned int flags;
324 #define SSH_CIPHER_IS_CBC       1
325 #define SSH_CIPHER_SEPARATE_LENGTH      2
326     const char *text_name;
327     /* If set, this takes priority over other MAC. */
328     const struct ssh_mac *required_mac;
329 };
330
331 struct ssh2_ciphers {
332     int nciphers;
333     const struct ssh2_cipher *const *list;
334 };
335
336 struct ssh_mac {
337     /* Passes in the cipher context */
338     void *(*make_context)(void *);
339     void (*free_context)(void *);
340     void (*setkey) (void *, unsigned char *key);
341     /* whole-packet operations */
342     void (*generate) (void *, unsigned char *blk, int len, unsigned long seq);
343     int (*verify) (void *, unsigned char *blk, int len, unsigned long seq);
344     /* partial-packet operations */
345     void (*start) (void *);
346     void (*bytes) (void *, unsigned char const *, int);
347     void (*genresult) (void *, unsigned char *);
348     int (*verresult) (void *, unsigned char const *);
349     const char *name, *etm_name;
350     int len, keylen;
351     const char *text_name;
352 };
353
354 struct ssh_hash {
355     void *(*init)(void); /* also allocates context */
356     void *(*copy)(const void *);
357     void (*bytes)(void *, const void *, int);
358     void (*final)(void *, unsigned char *); /* also frees context */
359     void (*free)(void *);
360     int hlen; /* output length in bytes */
361     const char *text_name;
362 };   
363
364 struct ssh_kex {
365     const char *name, *groupname;
366     enum { KEXTYPE_DH, KEXTYPE_RSA, KEXTYPE_ECDH } main_type;
367     const struct ssh_hash *hash;
368     const void *extra;                 /* private to the kex methods */
369 };
370
371 struct ssh_kexes {
372     int nkexes;
373     const struct ssh_kex *const *list;
374 };
375
376 struct ssh_signkey {
377     void *(*newkey) (const struct ssh_signkey *self,
378                      const char *data, int len);
379     void (*freekey) (void *key);
380     char *(*fmtkey) (void *key);
381     unsigned char *(*public_blob) (void *key, int *len);
382     unsigned char *(*private_blob) (void *key, int *len);
383     void *(*createkey) (const struct ssh_signkey *self,
384                         const unsigned char *pub_blob, int pub_len,
385                         const unsigned char *priv_blob, int priv_len);
386     void *(*openssh_createkey) (const struct ssh_signkey *self,
387                                 const unsigned char **blob, int *len);
388     int (*openssh_fmtkey) (void *key, unsigned char *blob, int len);
389     /* OpenSSH private key blobs, as created by openssh_fmtkey and
390      * consumed by openssh_createkey, always (at least so far...) take
391      * the form of a number of SSH-2 strings / mpints concatenated
392      * end-to-end. Because the new-style OpenSSH private key format
393      * stores those blobs without a containing string wrapper, we need
394      * to know how many strings each one consists of, so that we can
395      * skip over the right number to find the next key in the file.
396      * openssh_private_npieces gives that information. */
397     int openssh_private_npieces;
398     int (*pubkey_bits) (const struct ssh_signkey *self,
399                         const void *blob, int len);
400     int (*verifysig) (void *key, const char *sig, int siglen,
401                       const char *data, int datalen);
402     unsigned char *(*sign) (void *key, const char *data, int datalen,
403                             int *siglen);
404     const char *name;
405     const char *keytype;               /* for host key cache */
406     const void *extra;                 /* private to the public key methods */
407 };
408
409 struct ssh_compress {
410     const char *name;
411     /* For zlib@openssh.com: if non-NULL, this name will be considered once
412      * userauth has completed successfully. */
413     const char *delayed_name;
414     void *(*compress_init) (void);
415     void (*compress_cleanup) (void *);
416     int (*compress) (void *, unsigned char *block, int len,
417                      unsigned char **outblock, int *outlen);
418     void *(*decompress_init) (void);
419     void (*decompress_cleanup) (void *);
420     int (*decompress) (void *, unsigned char *block, int len,
421                        unsigned char **outblock, int *outlen);
422     int (*disable_compression) (void *);
423     const char *text_name;
424 };
425
426 struct ssh2_userkey {
427     const struct ssh_signkey *alg;     /* the key algorithm */
428     void *data;                        /* the key data */
429     char *comment;                     /* the key comment */
430 };
431
432 /* The maximum length of any hash algorithm used in kex. (bytes) */
433 #define SSH2_KEX_MAX_HASH_LEN (64) /* SHA-512 */
434
435 extern const struct ssh_cipher ssh_3des;
436 extern const struct ssh_cipher ssh_des;
437 extern const struct ssh_cipher ssh_blowfish_ssh1;
438 extern const struct ssh2_ciphers ssh2_3des;
439 extern const struct ssh2_ciphers ssh2_des;
440 extern const struct ssh2_ciphers ssh2_aes;
441 extern const struct ssh2_ciphers ssh2_blowfish;
442 extern const struct ssh2_ciphers ssh2_arcfour;
443 extern const struct ssh2_ciphers ssh2_ccp;
444 extern const struct ssh_hash ssh_sha1;
445 extern const struct ssh_hash ssh_sha256;
446 extern const struct ssh_hash ssh_sha384;
447 extern const struct ssh_hash ssh_sha512;
448 extern const struct ssh_kexes ssh_diffiehellman_group1;
449 extern const struct ssh_kexes ssh_diffiehellman_group14;
450 extern const struct ssh_kexes ssh_diffiehellman_gex;
451 extern const struct ssh_kexes ssh_rsa_kex;
452 extern const struct ssh_kexes ssh_ecdh_kex;
453 extern const struct ssh_signkey ssh_dss;
454 extern const struct ssh_signkey ssh_rsa;
455 extern const struct ssh_signkey ssh_ecdsa_ed25519;
456 extern const struct ssh_signkey ssh_ecdsa_nistp256;
457 extern const struct ssh_signkey ssh_ecdsa_nistp384;
458 extern const struct ssh_signkey ssh_ecdsa_nistp521;
459 extern const struct ssh_mac ssh_hmac_md5;
460 extern const struct ssh_mac ssh_hmac_sha1;
461 extern const struct ssh_mac ssh_hmac_sha1_buggy;
462 extern const struct ssh_mac ssh_hmac_sha1_96;
463 extern const struct ssh_mac ssh_hmac_sha1_96_buggy;
464 extern const struct ssh_mac ssh_hmac_sha256;
465
466 void *aes_make_context(void);
467 void aes_free_context(void *handle);
468 void aes128_key(void *handle, unsigned char *key);
469 void aes192_key(void *handle, unsigned char *key);
470 void aes256_key(void *handle, unsigned char *key);
471 void aes_iv(void *handle, unsigned char *iv);
472 void aes_ssh2_encrypt_blk(void *handle, unsigned char *blk, int len);
473 void aes_ssh2_decrypt_blk(void *handle, unsigned char *blk, int len);
474
475 /*
476  * PuTTY version number formatted as an SSH version string. 
477  */
478 extern char sshver[];
479
480 /*
481  * Gross hack: pscp will try to start SFTP but fall back to scp1 if
482  * that fails. This variable is the means by which scp.c can reach
483  * into the SSH code and find out which one it got.
484  */
485 extern int ssh_fallback_cmd(void *handle);
486
487 #ifndef MSCRYPTOAPI
488 void SHATransform(word32 * digest, word32 * data);
489 #endif
490
491 int random_byte(void);
492 void random_add_noise(void *noise, int length);
493 void random_add_heavynoise(void *noise, int length);
494
495 void logevent(void *, const char *);
496
497 struct PortForwarding;
498
499 /* Allocate and register a new channel for port forwarding */
500 void *new_sock_channel(void *handle, struct PortForwarding *pf);
501 void ssh_send_port_open(void *channel, const char *hostname, int port,
502                         const char *org);
503
504 /* Exports from portfwd.c */
505 extern char *pfd_connect(struct PortForwarding **pf, char *hostname, int port,
506                          void *c, Conf *conf, int addressfamily);
507 extern void pfd_close(struct PortForwarding *);
508 extern int pfd_send(struct PortForwarding *, char *data, int len);
509 extern void pfd_send_eof(struct PortForwarding *);
510 extern void pfd_confirm(struct PortForwarding *);
511 extern void pfd_unthrottle(struct PortForwarding *);
512 extern void pfd_override_throttle(struct PortForwarding *, int enable);
513 struct PortListener;
514 /* desthost == NULL indicates dynamic (SOCKS) port forwarding */
515 extern char *pfl_listen(char *desthost, int destport, char *srcaddr,
516                         int port, void *backhandle, Conf *conf,
517                         struct PortListener **pl, int address_family);
518 extern void pfl_terminate(struct PortListener *);
519
520 /* Exports from x11fwd.c */
521 enum {
522     X11_TRANS_IPV4 = 0, X11_TRANS_IPV6 = 6, X11_TRANS_UNIX = 256
523 };
524 struct X11Display {
525     /* Broken-down components of the display name itself */
526     int unixdomain;
527     char *hostname;
528     int displaynum;
529     int screennum;
530     /* OSX sometimes replaces all the above with a full Unix-socket pathname */
531     char *unixsocketpath;
532
533     /* PuTTY networking SockAddr to connect to the display, and associated
534      * gubbins */
535     SockAddr addr;
536     int port;
537     char *realhost;
538
539     /* Our local auth details for talking to the real X display. */
540     int localauthproto;
541     unsigned char *localauthdata;
542     int localauthdatalen;
543 };
544 struct X11FakeAuth {
545     /* Auth details we invented for a virtual display on the SSH server. */
546     int proto;
547     unsigned char *data;
548     int datalen;
549     char *protoname;
550     char *datastring;
551
552     /* The encrypted form of the first block, in XDM-AUTHORIZATION-1.
553      * Used as part of the key when these structures are organised
554      * into a tree. See x11_invent_fake_auth for explanation. */
555     unsigned char *xa1_firstblock;
556
557     /*
558      * Used inside x11fwd.c to remember recently seen
559      * XDM-AUTHORIZATION-1 strings, to avoid replay attacks.
560      */
561     tree234 *xdmseen;
562
563     /*
564      * What to do with an X connection matching this auth data.
565      */
566     struct X11Display *disp;
567     void *share_cs, *share_chan;
568 };
569 void *x11_make_greeting(int endian, int protomajor, int protominor,
570                         int auth_proto, const void *auth_data, int auth_len,
571                         const char *peer_ip, int peer_port,
572                         int *outlen);
573 int x11_authcmp(void *av, void *bv); /* for putting X11FakeAuth in a tree234 */
574 /*
575  * x11_setup_display() parses the display variable and fills in an
576  * X11Display structure. Some remote auth details are invented;
577  * the supplied authtype parameter configures the preferred
578  * authorisation protocol to use at the remote end. The local auth
579  * details are looked up by calling platform_get_x11_auth.
580  */
581 extern struct X11Display *x11_setup_display(const char *display, Conf *);
582 void x11_free_display(struct X11Display *disp);
583 struct X11FakeAuth *x11_invent_fake_auth(tree234 *t, int authtype);
584 void x11_free_fake_auth(struct X11FakeAuth *auth);
585 struct X11Connection;                  /* opaque outside x11fwd.c */
586 struct X11Connection *x11_init(tree234 *authtree, void *, const char *, int);
587 extern void x11_close(struct X11Connection *);
588 extern int x11_send(struct X11Connection *, char *, int);
589 extern void x11_send_eof(struct X11Connection *s);
590 extern void x11_unthrottle(struct X11Connection *s);
591 extern void x11_override_throttle(struct X11Connection *s, int enable);
592 char *x11_display(const char *display);
593 /* Platform-dependent X11 functions */
594 extern void platform_get_x11_auth(struct X11Display *display, Conf *);
595     /* examine a mostly-filled-in X11Display and fill in localauth* */
596 extern const int platform_uses_x11_unix_by_default;
597     /* choose default X transport in the absence of a specified one */
598 SockAddr platform_get_x11_unix_address(const char *path, int displaynum);
599     /* make up a SockAddr naming the address for displaynum */
600 char *platform_get_x_display(void);
601     /* allocated local X display string, if any */
602 /* Callbacks in x11.c usable _by_ platform X11 functions */
603 /*
604  * This function does the job of platform_get_x11_auth, provided
605  * it is told where to find a normally formatted .Xauthority file:
606  * it opens that file, parses it to find an auth record which
607  * matches the display details in "display", and fills in the
608  * localauth fields.
609  *
610  * It is expected that most implementations of
611  * platform_get_x11_auth() will work by finding their system's
612  * .Xauthority file, adjusting the display details if necessary
613  * for local oddities like Unix-domain socket transport, and
614  * calling this function to do the rest of the work.
615  */
616 void x11_get_auth_from_authfile(struct X11Display *display,
617                                 const char *authfilename);
618 int x11_identify_auth_proto(const char *proto);
619 void *x11_dehexify(const char *hex, int *outlen);
620
621 Bignum copybn(Bignum b);
622 Bignum bn_power_2(int n);
623 void bn_restore_invariant(Bignum b);
624 Bignum bignum_from_long(unsigned long n);
625 void freebn(Bignum b);
626 Bignum modpow(Bignum base, Bignum exp, Bignum mod);
627 Bignum modmul(Bignum a, Bignum b, Bignum mod);
628 Bignum modsub(const Bignum a, const Bignum b, const Bignum n);
629 void decbn(Bignum n);
630 extern Bignum Zero, One;
631 Bignum bignum_from_bytes(const unsigned char *data, int nbytes);
632 Bignum bignum_from_bytes_le(const unsigned char *data, int nbytes);
633 Bignum bignum_random_in_range(const Bignum lower, const Bignum upper);
634 int ssh1_read_bignum(const unsigned char *data, int len, Bignum * result);
635 int bignum_bitcount(Bignum bn);
636 int ssh1_bignum_length(Bignum bn);
637 int ssh2_bignum_length(Bignum bn);
638 int bignum_byte(Bignum bn, int i);
639 int bignum_bit(Bignum bn, int i);
640 void bignum_set_bit(Bignum bn, int i, int value);
641 int ssh1_write_bignum(void *data, Bignum bn);
642 Bignum biggcd(Bignum a, Bignum b);
643 unsigned short bignum_mod_short(Bignum number, unsigned short modulus);
644 Bignum bignum_add_long(Bignum number, unsigned long addend);
645 Bignum bigadd(Bignum a, Bignum b);
646 Bignum bigsub(Bignum a, Bignum b);
647 Bignum bigmul(Bignum a, Bignum b);
648 Bignum bigmuladd(Bignum a, Bignum b, Bignum addend);
649 Bignum bigdiv(Bignum a, Bignum b);
650 Bignum bigmod(Bignum a, Bignum b);
651 Bignum modinv(Bignum number, Bignum modulus);
652 Bignum bignum_bitmask(Bignum number);
653 Bignum bignum_rshift(Bignum number, int shift);
654 Bignum bignum_lshift(Bignum number, int shift);
655 int bignum_cmp(Bignum a, Bignum b);
656 char *bignum_decimal(Bignum x);
657 Bignum bignum_from_decimal(const char *decimal);
658
659 #ifdef DEBUG
660 void diagbn(char *prefix, Bignum md);
661 #endif
662
663 int dh_is_gex(const struct ssh_kex *kex);
664 void *dh_setup_group(const struct ssh_kex *kex);
665 void *dh_setup_gex(Bignum pval, Bignum gval);
666 void dh_cleanup(void *);
667 Bignum dh_create_e(void *, int nbits);
668 const char *dh_validate_f(void *handle, Bignum f);
669 Bignum dh_find_K(void *, Bignum f);
670
671 int loadrsakey(const Filename *filename, struct RSAKey *key,
672                const char *passphrase, const char **errorstr);
673 int rsakey_encrypted(const Filename *filename, char **comment);
674 int rsakey_pubblob(const Filename *filename, void **blob, int *bloblen,
675                    char **commentptr, const char **errorstr);
676
677 int saversakey(const Filename *filename, struct RSAKey *key, char *passphrase);
678
679 extern int base64_decode_atom(const char *atom, unsigned char *out);
680 extern int base64_lines(int datalen);
681 extern void base64_encode_atom(const unsigned char *data, int n, char *out);
682 extern void base64_encode(FILE *fp, const unsigned char *data, int datalen,
683                           int cpl);
684
685 /* ssh2_load_userkey can return this as an error */
686 extern struct ssh2_userkey ssh2_wrong_passphrase;
687 #define SSH2_WRONG_PASSPHRASE (&ssh2_wrong_passphrase)
688
689 int ssh2_userkey_encrypted(const Filename *filename, char **comment);
690 struct ssh2_userkey *ssh2_load_userkey(const Filename *filename,
691                                        const char *passphrase,
692                                        const char **errorstr);
693 unsigned char *ssh2_userkey_loadpub(const Filename *filename, char **algorithm,
694                                     int *pub_blob_len, char **commentptr,
695                                     const char **errorstr);
696 int ssh2_save_userkey(const Filename *filename, struct ssh2_userkey *key,
697                       char *passphrase);
698 const struct ssh_signkey *find_pubkey_alg(const char *name);
699 const struct ssh_signkey *find_pubkey_alg_len(int namelen, const char *name);
700
701 enum {
702     SSH_KEYTYPE_UNOPENABLE,
703     SSH_KEYTYPE_UNKNOWN,
704     SSH_KEYTYPE_SSH1, SSH_KEYTYPE_SSH2,
705     /*
706      * The OpenSSH key types deserve a little explanation. OpenSSH has
707      * two physical formats for private key storage: an old PEM-based
708      * one largely dictated by their use of OpenSSL and full of ASN.1,
709      * and a new one using the same private key formats used over the
710      * wire for talking to ssh-agent. The old format can only support
711      * a subset of the key types, because it needs redesign for each
712      * key type, and after a while they decided to move to the new
713      * format so as not to have to do that.
714      *
715      * On input, key files are identified as either
716      * SSH_KEYTYPE_OPENSSH_PEM or SSH_KEYTYPE_OPENSSH_NEW, describing
717      * accurately which actual format the keys are stored in.
718      *
719      * On output, however, we default to following OpenSSH's own
720      * policy of writing out PEM-style keys for maximum backwards
721      * compatibility if the key type supports it, and otherwise
722      * switching to the new format. So the formats you can select for
723      * output are SSH_KEYTYPE_OPENSSH_NEW (forcing the new format for
724      * any key type), and SSH_KEYTYPE_OPENSSH_AUTO to use the oldest
725      * format supported by whatever key type you're writing out.
726      *
727      * So we have three type codes, but only two of them usable in any
728      * given circumstance. An input key file will never be identified
729      * as AUTO, only PEM or NEW; key export UIs should not be able to
730      * select PEM, only AUTO or NEW.
731      */
732     SSH_KEYTYPE_OPENSSH_AUTO,
733     SSH_KEYTYPE_OPENSSH_PEM,
734     SSH_KEYTYPE_OPENSSH_NEW,
735     SSH_KEYTYPE_SSHCOM,
736     /*
737      * Public-key-only formats, which we still want to be able to read
738      * for various purposes.
739      */
740     SSH_KEYTYPE_SSH1_PUBLIC,
741     SSH_KEYTYPE_SSH2_PUBLIC_RFC4716,
742     SSH_KEYTYPE_SSH2_PUBLIC_OPENSSH
743 };
744 char *ssh1_pubkey_str(struct RSAKey *ssh1key);
745 void ssh1_write_pubkey(FILE *fp, struct RSAKey *ssh1key);
746 char *ssh2_pubkey_openssh_str(struct ssh2_userkey *key);
747 void ssh2_write_pubkey(FILE *fp, const char *comment,
748                        const void *v_pub_blob, int pub_len,
749                        int keytype);
750 char *ssh2_fingerprint_blob(const void *blob, int bloblen);
751 char *ssh2_fingerprint(const struct ssh_signkey *alg, void *data);
752 int key_type(const Filename *filename);
753 const char *key_type_to_str(int type);
754
755 int import_possible(int type);
756 int import_target_type(int type);
757 int import_encrypted(const Filename *filename, int type, char **comment);
758 int import_ssh1(const Filename *filename, int type,
759                 struct RSAKey *key, char *passphrase, const char **errmsg_p);
760 struct ssh2_userkey *import_ssh2(const Filename *filename, int type,
761                                  char *passphrase, const char **errmsg_p);
762 int export_ssh1(const Filename *filename, int type,
763                 struct RSAKey *key, char *passphrase);
764 int export_ssh2(const Filename *filename, int type,
765                 struct ssh2_userkey *key, char *passphrase);
766
767 void des3_decrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
768 void des3_encrypt_pubkey(unsigned char *key, unsigned char *blk, int len);
769 void des3_decrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
770                               unsigned char *blk, int len);
771 void des3_encrypt_pubkey_ossh(unsigned char *key, unsigned char *iv,
772                               unsigned char *blk, int len);
773 void aes256_encrypt_pubkey(unsigned char *key, unsigned char *blk,
774                            int len);
775 void aes256_decrypt_pubkey(unsigned char *key, unsigned char *blk,
776                            int len);
777
778 void des_encrypt_xdmauth(const unsigned char *key,
779                          unsigned char *blk, int len);
780 void des_decrypt_xdmauth(const unsigned char *key,
781                          unsigned char *blk, int len);
782
783 void openssh_bcrypt(const char *passphrase,
784                     const unsigned char *salt, int saltbytes,
785                     int rounds, unsigned char *out, int outbytes);
786
787 /*
788  * For progress updates in the key generation utility.
789  */
790 #define PROGFN_INITIALISE 1
791 #define PROGFN_LIN_PHASE 2
792 #define PROGFN_EXP_PHASE 3
793 #define PROGFN_PHASE_EXTENT 4
794 #define PROGFN_READY 5
795 #define PROGFN_PROGRESS 6
796 typedef void (*progfn_t) (void *param, int action, int phase, int progress);
797
798 int rsa_generate(struct RSAKey *key, int bits, progfn_t pfn,
799                  void *pfnparam);
800 int dsa_generate(struct dss_key *key, int bits, progfn_t pfn,
801                  void *pfnparam);
802 int ec_generate(struct ec_key *key, int bits, progfn_t pfn,
803                 void *pfnparam);
804 int ec_edgenerate(struct ec_key *key, int bits, progfn_t pfn,
805                   void *pfnparam);
806 Bignum primegen(int bits, int modulus, int residue, Bignum factor,
807                 int phase, progfn_t pfn, void *pfnparam, unsigned firstbits);
808 void invent_firstbits(unsigned *one, unsigned *two);
809
810
811 /*
812  * zlib compression.
813  */
814 void *zlib_compress_init(void);
815 void zlib_compress_cleanup(void *);
816 void *zlib_decompress_init(void);
817 void zlib_decompress_cleanup(void *);
818 int zlib_compress_block(void *, unsigned char *block, int len,
819                         unsigned char **outblock, int *outlen);
820 int zlib_decompress_block(void *, unsigned char *block, int len,
821                           unsigned char **outblock, int *outlen);
822
823 /*
824  * Connection-sharing API provided by platforms. This function must
825  * either:
826  *  - return SHARE_NONE and do nothing
827  *  - return SHARE_DOWNSTREAM and set *sock to a Socket connected to
828  *    downplug
829  *  - return SHARE_UPSTREAM and set *sock to a Socket connected to
830  *    upplug.
831  */
832 enum { SHARE_NONE, SHARE_DOWNSTREAM, SHARE_UPSTREAM };
833 int platform_ssh_share(const char *name, Conf *conf,
834                        Plug downplug, Plug upplug, Socket *sock,
835                        char **logtext, char **ds_err, char **us_err,
836                        int can_upstream, int can_downstream);
837 void platform_ssh_share_cleanup(const char *name);
838
839 /*
840  * SSH-1 message type codes.
841  */
842 #define SSH1_MSG_DISCONNECT                       1     /* 0x1 */
843 #define SSH1_SMSG_PUBLIC_KEY                      2     /* 0x2 */
844 #define SSH1_CMSG_SESSION_KEY                     3     /* 0x3 */
845 #define SSH1_CMSG_USER                            4     /* 0x4 */
846 #define SSH1_CMSG_AUTH_RSA                        6     /* 0x6 */
847 #define SSH1_SMSG_AUTH_RSA_CHALLENGE              7     /* 0x7 */
848 #define SSH1_CMSG_AUTH_RSA_RESPONSE               8     /* 0x8 */
849 #define SSH1_CMSG_AUTH_PASSWORD                   9     /* 0x9 */
850 #define SSH1_CMSG_REQUEST_PTY                     10    /* 0xa */
851 #define SSH1_CMSG_WINDOW_SIZE                     11    /* 0xb */
852 #define SSH1_CMSG_EXEC_SHELL                      12    /* 0xc */
853 #define SSH1_CMSG_EXEC_CMD                        13    /* 0xd */
854 #define SSH1_SMSG_SUCCESS                         14    /* 0xe */
855 #define SSH1_SMSG_FAILURE                         15    /* 0xf */
856 #define SSH1_CMSG_STDIN_DATA                      16    /* 0x10 */
857 #define SSH1_SMSG_STDOUT_DATA                     17    /* 0x11 */
858 #define SSH1_SMSG_STDERR_DATA                     18    /* 0x12 */
859 #define SSH1_CMSG_EOF                             19    /* 0x13 */
860 #define SSH1_SMSG_EXIT_STATUS                     20    /* 0x14 */
861 #define SSH1_MSG_CHANNEL_OPEN_CONFIRMATION        21    /* 0x15 */
862 #define SSH1_MSG_CHANNEL_OPEN_FAILURE             22    /* 0x16 */
863 #define SSH1_MSG_CHANNEL_DATA                     23    /* 0x17 */
864 #define SSH1_MSG_CHANNEL_CLOSE                    24    /* 0x18 */
865 #define SSH1_MSG_CHANNEL_CLOSE_CONFIRMATION       25    /* 0x19 */
866 #define SSH1_SMSG_X11_OPEN                        27    /* 0x1b */
867 #define SSH1_CMSG_PORT_FORWARD_REQUEST            28    /* 0x1c */
868 #define SSH1_MSG_PORT_OPEN                        29    /* 0x1d */
869 #define SSH1_CMSG_AGENT_REQUEST_FORWARDING        30    /* 0x1e */
870 #define SSH1_SMSG_AGENT_OPEN                      31    /* 0x1f */
871 #define SSH1_MSG_IGNORE                           32    /* 0x20 */
872 #define SSH1_CMSG_EXIT_CONFIRMATION               33    /* 0x21 */
873 #define SSH1_CMSG_X11_REQUEST_FORWARDING          34    /* 0x22 */
874 #define SSH1_CMSG_AUTH_RHOSTS_RSA                 35    /* 0x23 */
875 #define SSH1_MSG_DEBUG                            36    /* 0x24 */
876 #define SSH1_CMSG_REQUEST_COMPRESSION             37    /* 0x25 */
877 #define SSH1_CMSG_AUTH_TIS                        39    /* 0x27 */
878 #define SSH1_SMSG_AUTH_TIS_CHALLENGE              40    /* 0x28 */
879 #define SSH1_CMSG_AUTH_TIS_RESPONSE               41    /* 0x29 */
880 #define SSH1_CMSG_AUTH_CCARD                      70    /* 0x46 */
881 #define SSH1_SMSG_AUTH_CCARD_CHALLENGE            71    /* 0x47 */
882 #define SSH1_CMSG_AUTH_CCARD_RESPONSE             72    /* 0x48 */
883
884 #define SSH1_AUTH_RHOSTS                          1     /* 0x1 */
885 #define SSH1_AUTH_RSA                             2     /* 0x2 */
886 #define SSH1_AUTH_PASSWORD                        3     /* 0x3 */
887 #define SSH1_AUTH_RHOSTS_RSA                      4     /* 0x4 */
888 #define SSH1_AUTH_TIS                             5     /* 0x5 */
889 #define SSH1_AUTH_CCARD                           16    /* 0x10 */
890
891 #define SSH1_PROTOFLAG_SCREEN_NUMBER              1     /* 0x1 */
892 /* Mask for protoflags we will echo back to server if seen */
893 #define SSH1_PROTOFLAGS_SUPPORTED                 0     /* 0x1 */
894
895 /*
896  * SSH-2 message type codes.
897  */
898 #define SSH2_MSG_DISCONNECT                       1     /* 0x1 */
899 #define SSH2_MSG_IGNORE                           2     /* 0x2 */
900 #define SSH2_MSG_UNIMPLEMENTED                    3     /* 0x3 */
901 #define SSH2_MSG_DEBUG                            4     /* 0x4 */
902 #define SSH2_MSG_SERVICE_REQUEST                  5     /* 0x5 */
903 #define SSH2_MSG_SERVICE_ACCEPT                   6     /* 0x6 */
904 #define SSH2_MSG_KEXINIT                          20    /* 0x14 */
905 #define SSH2_MSG_NEWKEYS                          21    /* 0x15 */
906 #define SSH2_MSG_KEXDH_INIT                       30    /* 0x1e */
907 #define SSH2_MSG_KEXDH_REPLY                      31    /* 0x1f */
908 #define SSH2_MSG_KEX_DH_GEX_REQUEST_OLD           30    /* 0x1e */
909 #define SSH2_MSG_KEX_DH_GEX_REQUEST               34    /* 0x22 */
910 #define SSH2_MSG_KEX_DH_GEX_GROUP                 31    /* 0x1f */
911 #define SSH2_MSG_KEX_DH_GEX_INIT                  32    /* 0x20 */
912 #define SSH2_MSG_KEX_DH_GEX_REPLY                 33    /* 0x21 */
913 #define SSH2_MSG_KEXRSA_PUBKEY                    30    /* 0x1e */
914 #define SSH2_MSG_KEXRSA_SECRET                    31    /* 0x1f */
915 #define SSH2_MSG_KEXRSA_DONE                      32    /* 0x20 */
916 #define SSH2_MSG_KEX_ECDH_INIT                    30    /* 0x1e */
917 #define SSH2_MSG_KEX_ECDH_REPLY                   31    /* 0x1f */
918 #define SSH2_MSG_KEX_ECMQV_INIT                   30    /* 0x1e */
919 #define SSH2_MSG_KEX_ECMQV_REPLY                  31    /* 0x1f */
920 #define SSH2_MSG_USERAUTH_REQUEST                 50    /* 0x32 */
921 #define SSH2_MSG_USERAUTH_FAILURE                 51    /* 0x33 */
922 #define SSH2_MSG_USERAUTH_SUCCESS                 52    /* 0x34 */
923 #define SSH2_MSG_USERAUTH_BANNER                  53    /* 0x35 */
924 #define SSH2_MSG_USERAUTH_PK_OK                   60    /* 0x3c */
925 #define SSH2_MSG_USERAUTH_PASSWD_CHANGEREQ        60    /* 0x3c */
926 #define SSH2_MSG_USERAUTH_INFO_REQUEST            60    /* 0x3c */
927 #define SSH2_MSG_USERAUTH_INFO_RESPONSE           61    /* 0x3d */
928 #define SSH2_MSG_GLOBAL_REQUEST                   80    /* 0x50 */
929 #define SSH2_MSG_REQUEST_SUCCESS                  81    /* 0x51 */
930 #define SSH2_MSG_REQUEST_FAILURE                  82    /* 0x52 */
931 #define SSH2_MSG_CHANNEL_OPEN                     90    /* 0x5a */
932 #define SSH2_MSG_CHANNEL_OPEN_CONFIRMATION        91    /* 0x5b */
933 #define SSH2_MSG_CHANNEL_OPEN_FAILURE             92    /* 0x5c */
934 #define SSH2_MSG_CHANNEL_WINDOW_ADJUST            93    /* 0x5d */
935 #define SSH2_MSG_CHANNEL_DATA                     94    /* 0x5e */
936 #define SSH2_MSG_CHANNEL_EXTENDED_DATA            95    /* 0x5f */
937 #define SSH2_MSG_CHANNEL_EOF                      96    /* 0x60 */
938 #define SSH2_MSG_CHANNEL_CLOSE                    97    /* 0x61 */
939 #define SSH2_MSG_CHANNEL_REQUEST                  98    /* 0x62 */
940 #define SSH2_MSG_CHANNEL_SUCCESS                  99    /* 0x63 */
941 #define SSH2_MSG_CHANNEL_FAILURE                  100   /* 0x64 */
942 #define SSH2_MSG_USERAUTH_GSSAPI_RESPONSE               60
943 #define SSH2_MSG_USERAUTH_GSSAPI_TOKEN                  61
944 #define SSH2_MSG_USERAUTH_GSSAPI_EXCHANGE_COMPLETE      63
945 #define SSH2_MSG_USERAUTH_GSSAPI_ERROR                  64
946 #define SSH2_MSG_USERAUTH_GSSAPI_ERRTOK                 65
947 #define SSH2_MSG_USERAUTH_GSSAPI_MIC                    66
948
949 /*
950  * SSH-1 agent messages.
951  */
952 #define SSH1_AGENTC_REQUEST_RSA_IDENTITIES    1
953 #define SSH1_AGENT_RSA_IDENTITIES_ANSWER      2
954 #define SSH1_AGENTC_RSA_CHALLENGE             3
955 #define SSH1_AGENT_RSA_RESPONSE               4
956 #define SSH1_AGENTC_ADD_RSA_IDENTITY          7
957 #define SSH1_AGENTC_REMOVE_RSA_IDENTITY       8
958 #define SSH1_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9 /* openssh private? */
959
960 /*
961  * Messages common to SSH-1 and OpenSSH's SSH-2.
962  */
963 #define SSH_AGENT_FAILURE                    5
964 #define SSH_AGENT_SUCCESS                    6
965
966 /*
967  * OpenSSH's SSH-2 agent messages.
968  */
969 #define SSH2_AGENTC_REQUEST_IDENTITIES          11
970 #define SSH2_AGENT_IDENTITIES_ANSWER            12
971 #define SSH2_AGENTC_SIGN_REQUEST                13
972 #define SSH2_AGENT_SIGN_RESPONSE                14
973 #define SSH2_AGENTC_ADD_IDENTITY                17
974 #define SSH2_AGENTC_REMOVE_IDENTITY             18
975 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES       19
976
977 /*
978  * Assorted other SSH-related enumerations.
979  */
980 #define SSH2_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT 1   /* 0x1 */
981 #define SSH2_DISCONNECT_PROTOCOL_ERROR            2     /* 0x2 */
982 #define SSH2_DISCONNECT_KEY_EXCHANGE_FAILED       3     /* 0x3 */
983 #define SSH2_DISCONNECT_HOST_AUTHENTICATION_FAILED 4    /* 0x4 */
984 #define SSH2_DISCONNECT_MAC_ERROR                 5     /* 0x5 */
985 #define SSH2_DISCONNECT_COMPRESSION_ERROR         6     /* 0x6 */
986 #define SSH2_DISCONNECT_SERVICE_NOT_AVAILABLE     7     /* 0x7 */
987 #define SSH2_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED 8        /* 0x8 */
988 #define SSH2_DISCONNECT_HOST_KEY_NOT_VERIFIABLE   9     /* 0x9 */
989 #define SSH2_DISCONNECT_CONNECTION_LOST           10    /* 0xa */
990 #define SSH2_DISCONNECT_BY_APPLICATION            11    /* 0xb */
991 #define SSH2_DISCONNECT_TOO_MANY_CONNECTIONS      12    /* 0xc */
992 #define SSH2_DISCONNECT_AUTH_CANCELLED_BY_USER    13    /* 0xd */
993 #define SSH2_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE 14       /* 0xe */
994 #define SSH2_DISCONNECT_ILLEGAL_USER_NAME         15    /* 0xf */
995
996 #define SSH2_OPEN_ADMINISTRATIVELY_PROHIBITED     1     /* 0x1 */
997 #define SSH2_OPEN_CONNECT_FAILED                  2     /* 0x2 */
998 #define SSH2_OPEN_UNKNOWN_CHANNEL_TYPE            3     /* 0x3 */
999 #define SSH2_OPEN_RESOURCE_SHORTAGE               4     /* 0x4 */
1000
1001 #define SSH2_EXTENDED_DATA_STDERR                 1     /* 0x1 */
1002
1003 /*
1004  * Need this to warn about support for the original SSH-2 keyfile
1005  * format.
1006  */
1007 void old_keyfile_warning(void);