OpenVAS Libraries  8.0.3
network.h
Go to the documentation of this file.
1 /* OpenVAS
2  * $Id$
3  * Description: Header file for module network.
4  *
5  * Authors:
6  * Renaud Deraison <deraison@nessus.org> (Original pre-fork development)
7  *
8  * Copyright:
9  * Based on work Copyright (C) 1998 - 2007 Tenable Network Security, Inc.
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Library General Public
13  * License as published by the Free Software Foundation; either
14  * version 2 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Library General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24  */
25 
26 #ifndef OPENVAS_NETWORK_H
27 #define OPENVAS_NETWORK_H
28 
29 #include <sys/select.h> /* at least for fd_set */
30 #include <netinet/in.h> /* struct in_addr, struct in6_addr */
31 
32 #include <gnutls/gnutls.h>
33 #include <gnutls/x509.h>
34 
35 #include "arglists.h"
36 #include "../base/openvas_networking.h"
37 
38 /*
39  * Type of "transport layer", for encapsulated connections
40  * Only SSL is supported at this time.
41  * (Bad) examples of other layers could be SOCKS, httptunnel, icmptunnel,
42  * RMI over HTTP, DCOM over HTTP, TCP over TCP, etc.
43  */
44 typedef enum openvas_encaps {
45  OPENVAS_ENCAPS_AUTO = 0, /* Request auto detection. */
47  OPENVAS_ENCAPS_SSLv23, /* Ask for compatibility options */
53  OPENVAS_ENCAPS_TLScustom, /* SSL/TLS using custom priorities. */
56 
57 #define IS_ENCAPS_SSL(x) ((x) >= OPENVAS_ENCAPS_SSLv23 && (x) <= OPENVAS_ENCAPS_TLScustom)
58 
59 /* Plugin specific network functions */
60 int open_sock_tcp (struct arglist *, unsigned int, int);
61 int open_sock_option (struct arglist *, unsigned int, int, int, int);
62 int recv_line (int, char *, size_t);
63 int nrecv (int, void *, int, int);
64 int socket_close (int);
65 int get_sock_infos (int sock, int *r_transport, void **r_tls_session);
66 unsigned short *getpts (char *, int *);
67 
68 int open_stream_connection (struct arglist *, unsigned int, int, int);
69 int open_stream_connection_ext (struct arglist *, unsigned int, int, int,
70  const char *);
71 int open_stream_auto_encaps_ext (struct arglist *args, unsigned int port,
72  int timeout, int force);
73 
74 int write_stream_connection (int, void *buf, int n);
75 int read_stream_connection (int, void *, int);
76 int read_stream_connection_min (int, void *, int, int);
77 int nsend (int, void *, int, int);
78 void add_close_stream_connection_hook (int (*)(int));
79 int close_stream_connection (int);
80 
81 const char *get_encaps_name (openvas_encaps_t);
83 
84 /* Additional functions -- should not be used by the plugins */
85 int open_sock_opt_hn (const char *, unsigned int, int, int, int);
86 
87 int openvas_SSL_init (void);
88 
89 int stream_set_buffer (int, int);
90 int stream_get_buffer_sz (int);
91 int stream_get_err (int);
92 
95 
96 ovas_scanner_context_t
97 ovas_scanner_context_new (openvas_encaps_t, const char *, const char *,
98  const char *, const char *, const char *,
99  const char *);
100 
101 void ovas_scanner_context_free (ovas_scanner_context_t);
102 int ovas_scanner_context_attach (ovas_scanner_context_t ctx, int soc);
103 
104 int openvas_register_connection (int s, void *ssl,
105  gnutls_certificate_credentials_t certcred,
109 gnutls_session_t ovas_get_tlssession_from_connection (int);
110 
111 int stream_zero (fd_set *);
112 int stream_set (int, fd_set *);
113 
114 int os_send (int, void *, int, int);
115 int os_recv (int, void *, int, int);
116 
117 int internal_send (int, char *, int);
118 int internal_recv (int, char **, int *, int *);
119 
120 int fd_is_stream (int);
121 
122 int stream_set_timeout (int, int);
123 
124 int socket_negotiate_ssl (int, openvas_encaps_t, struct arglist *);
125 void socket_get_cert (int, void **, int *);
126 int socket_get_ssl_version (int);
127 void socket_get_ssl_session_id (int, void **, size_t *);
130 
131 #endif
int socket_close(int)
Definition: network.c:2265
int open_sock_option(struct arglist *, unsigned int, int, int, int)
Definition: network.c:2104
int read_stream_connection(int, void *, int)
Definition: network.c:1586
int openvas_register_connection(int s, void *ssl, gnutls_certificate_credentials_t certcred, openvas_encaps_t encaps)
Definition: network.c:270
const char * get_encaps_through(openvas_encaps_t)
Definition: network.c:1926
int internal_recv(int, char **, int *, int *)
Definition: network.c:2463
unsigned short * getpts(char *, int *)
Converts a string like "-100,200-1024,3000-4000,60000-" into an array.
Definition: network.c:2561
int stream_zero(fd_set *)
Definition: network.c:2275
int read_stream_connection_min(int, void *, int, int)
Definition: network.c:1525
int recv_line(int, char *, size_t)
Reads a text from the socket stream into the argument buffer, always.
Definition: network.c:2161
int stream_get_err(int)
Definition: network.c:164
Definition: network.h:50
Definition: network.h:47
enum openvas_encaps openvas_encaps_t
int stream_set_buffer(int, int)
Definition: network.c:2308
int nrecv(int, void *, int, int)
Definition: network.c:1783
Definition: network.h:52
int open_stream_auto_encaps_ext(struct arglist *args, unsigned int port, int timeout, int force)
Definition: network.c:1098
int get_sock_infos(int sock, int *r_transport, void **r_tls_session)
Definition: network.c:2521
gnutls_session_t ovas_get_tlssession_from_connection(int)
Definition: network.c:421
int close_stream_connection(int)
Definition: network.c:1864
Definition: network.h:51
int open_stream_connection_ext(struct arglist *, unsigned int, int, int, const char *)
Definition: network.c:988
int openvas_SSL_init(void)
Initializes SSL support.
Definition: network.c:379
int socket_negotiate_ssl(int, openvas_encaps_t, struct arglist *)
Definition: network.c:757
int os_send(int, void *, int, int)
Definition: network.c:2359
void ovas_scanner_context_free(ovas_scanner_context_t)
Frees the ovas_scanner_context_t instance ctx.
Definition: network.c:1212
void socket_get_cert(int, void **, int *)
Definition: network.c:792
ovas_scanner_context_t ovas_scanner_context_new(openvas_encaps_t, const char *, const char *, const char *, const char *, const char *, const char *)
Creates a new ovas_scanner_context_t.
Definition: network.c:1153
Definition: network.h:54
int socket_get_ssl_version(int)
Definition: network.c:828
int open_sock_tcp(struct arglist *, unsigned int, int)
Definition: network.c:2085
openvas_encaps
Definition: network.h:44
int open_sock_opt_hn(const char *, unsigned int, int, int, int)
Definition: network.c:2055
struct ovas_scanner_context_s * ovas_scanner_context_t
Definition: network.h:94
Definition: network.c:1132
Definition: arglists.h:29
int open_stream_connection(struct arglist *, unsigned int, int, int)
Definition: network.c:1089
int stream_set(int, fd_set *)
Definition: network.c:2282
int internal_send(int, char *, int)
Definition: network.c:2408
Definition: network.h:46
const char * get_encaps_name(openvas_encaps_t)
Definition: network.c:1896
int ovas_scanner_context_attach(ovas_scanner_context_t ctx, int soc)
Sets up SSL/TLS on the socket soc and returns a openvas file.
Definition: network.c:1237
int socket_get_ssl_ciphersuite(int)
Definition: network.c:949
int write_stream_connection(int, void *buf, int n)
Definition: network.c:1736
void socket_get_ssl_session_id(int, void **, size_t *)
Definition: network.c:869
Definition: network.h:48
Definition: network.h:49
int openvas_deregister_connection(int)
Definition: network.c:295
int nsend(int, void *, int, int)
Definition: network.c:1742
int openvas_get_socket_from_connection(int)
Definition: network.c:398
int os_recv(int, void *, int, int)
Definition: network.c:2378
openvas_encaps_t encaps
Definition: network.c:1135
void add_close_stream_connection_hook(int(*)(int))
int socket_get_ssl_compression(int)
Definition: network.c:909
int stream_get_buffer_sz(int)
Definition: network.c:2298
int fd_is_stream(int)
Definition: network.c:2291
Definition: network.h:53
int stream_set_timeout(int, int)
Definition: network.c:1313
Definition: network.h:45