xref: /openssl/apps/include/s_apps.h (revision fecb3aae)
1 /*
2  * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
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
8  */
9 
10 #include <openssl/opensslconf.h>
11 
12 #include <openssl/ssl.h>
13 #include <openssl/srp.h>
14 
15 #define PORT            "4433"
16 #define PROTOCOL        "tcp"
17 
18 #define SSL_VERSION_ALLOWS_RENEGOTIATION(s) \
19     (SSL_is_dtls(s) || (SSL_version(s) < TLS1_3_VERSION))
20 
21 typedef int (*do_server_cb)(int s, int stype, int prot, unsigned char *context);
22 void get_sock_info_address(int asock, char **hostname, char **service);
23 int report_server_accept(BIO *out, int asock, int with_address, int with_pid);
24 int do_server(int *accept_sock, const char *host, const char *port,
25               int family, int type, int protocol, do_server_cb cb,
26               unsigned char *context, int naccept, BIO *bio_s_out,
27               int tfo);
28 int verify_callback(int ok, X509_STORE_CTX *ctx);
29 
30 int set_cert_stuff(SSL_CTX *ctx, char *cert_file, char *key_file);
31 int set_cert_key_stuff(SSL_CTX *ctx, X509 *cert, EVP_PKEY *key,
32                        STACK_OF(X509) *chain, int build_chain);
33 int ssl_print_sigalgs(BIO *out, SSL *s);
34 int ssl_print_point_formats(BIO *out, SSL *s);
35 int ssl_print_groups(BIO *out, SSL *s, int noshared);
36 int ssl_print_tmp_key(BIO *out, SSL *s);
37 int init_client(int *sock, const char *host, const char *port,
38                 const char *bindhost, const char *bindport,
39                 int family, int type, int protocol, int tfo,
40                 BIO_ADDR **ba_ret);
41 int should_retry(int i);
42 void do_ssl_shutdown(SSL *ssl);
43 
44 long bio_dump_callback(BIO *bio, int cmd, const char *argp, size_t len,
45                        int argi, long argl, int ret, size_t *processed);
46 
47 void apps_ssl_info_callback(const SSL *s, int where, int ret);
48 void msg_cb(int write_p, int version, int content_type, const void *buf,
49             size_t len, SSL *ssl, void *arg);
50 void tlsext_cb(SSL *s, int client_server, int type, const unsigned char *data,
51                int len, void *arg);
52 
53 int generate_cookie_callback(SSL *ssl, unsigned char *cookie,
54                              unsigned int *cookie_len);
55 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie,
56                            unsigned int cookie_len);
57 
58 #ifdef __VMS                     /* 31 char symbol name limit */
59 # define generate_stateless_cookie_callback      generate_stateless_cookie_cb
60 # define verify_stateless_cookie_callback        verify_stateless_cookie_cb
61 #endif
62 
63 int generate_stateless_cookie_callback(SSL *ssl, unsigned char *cookie,
64                                        size_t *cookie_len);
65 int verify_stateless_cookie_callback(SSL *ssl, const unsigned char *cookie,
66                                      size_t cookie_len);
67 
68 typedef struct ssl_excert_st SSL_EXCERT;
69 
70 void ssl_ctx_set_excert(SSL_CTX *ctx, SSL_EXCERT *exc);
71 void ssl_excert_free(SSL_EXCERT *exc);
72 int args_excert(int option, SSL_EXCERT **pexc);
73 int load_excert(SSL_EXCERT **pexc);
74 void print_verify_detail(SSL *s, BIO *bio);
75 void print_ssl_summary(SSL *s);
76 int config_ctx(SSL_CONF_CTX *cctx, STACK_OF(OPENSSL_STRING) *str, SSL_CTX *ctx);
77 int ssl_ctx_add_crls(SSL_CTX *ctx, STACK_OF(X509_CRL) *crls,
78                      int crl_download);
79 int ssl_load_stores(SSL_CTX *ctx, const char *vfyCApath,
80                     const char *vfyCAfile, const char *vfyCAstore,
81                     const char *chCApath, const char *chCAfile,
82                     const char *chCAstore, STACK_OF(X509_CRL) *crls,
83                     int crl_download);
84 void ssl_ctx_security_debug(SSL_CTX *ctx, int verbose);
85 int set_keylog_file(SSL_CTX *ctx, const char *keylog_file);
86 void print_ca_names(BIO *bio, SSL *s);
87 void ssl_print_secure_renegotiation_notes(BIO *bio, SSL *s);
88 
89 #ifndef OPENSSL_NO_SRP
90 /* The client side SRP context that we pass to all SRP related callbacks */
91 typedef struct srp_arg_st {
92     char *srppassin;
93     char *srplogin;
94     int msg;                    /* copy from c_msg */
95     int debug;                  /* copy from c_debug */
96     int amp;                    /* allow more groups */
97     int strength;               /* minimal size for N */
98 } SRP_ARG;
99 
100 int set_up_srp_arg(SSL_CTX *ctx, SRP_ARG *srp_arg, int srp_lateuser, int c_msg,
101                    int c_debug);
102 void set_up_dummy_srp(SSL_CTX *ctx);
103 
104 /* The server side SRP context that we pass to all SRP related callbacks */
105 typedef struct srpsrvparm_st {
106     char *login;
107     SRP_VBASE *vb;
108     SRP_user_pwd *user;
109 } srpsrvparm;
110 
111 int set_up_srp_verifier_file(SSL_CTX *ctx, srpsrvparm *srp_callback_parm,
112                              char *srpuserseed, char *srp_verifier_file);
113 void lookup_srp_user(srpsrvparm *srp_callback_parm, BIO *bio_s_out);
114 #endif /* OPENSSL_NO_SRP */
115