OpenVAS Libraries  8.0.8
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 open_stream_connection_ext(struct arglist *args, unsigned int port, int transport, int timeout, const char *priority)
Definition: network.c:993
void *struct arglist * args
Definition: arglists.c:236
int open_sock_option(struct arglist *args, unsigned int port, int type, int protocol, int timeout)
Definition: network.c:2130
const char * get_encaps_name(openvas_encaps_t code)
Definition: network.c:1899
naslctxt * ctx
Definition: nasl_grammar.tab.c:2990
int os_send(int soc, void *buf, int len, int opt)
Definition: network.c:2387
int n
Definition: ids_send.c:235
else return open_sock_tcp(args, port, timeout)
int open_stream_auto_encaps_ext(struct arglist *args, unsigned int port, int timeout, int force)
Definition: network.c:1109
int openvas_deregister_connection(int fd)
Definition: network.c:296
int openvas_get_socket_from_connection(int fd)
Definition: network.c:399
Definition: network.h:50
Definition: network.h:47
int open_stream_connection(struct arglist *args, unsigned int port, int transport, int timeout)
Definition: network.c:1100
enum openvas_encaps openvas_encaps_t
int stream_set(int fd, fd_set *set)
Definition: network.c:2310
int openvas_register_connection(int soc, void *ssl, gnutls_certificate_credentials_t certcred, openvas_encaps_t encaps)
Definition: network.c:271
char * buf
Definition: ids_send.c:544
int recv_line(int soc, char *buf, size_t bufsiz)
Reads a text from the socket stream into the argument buffer, always.
Definition: network.c:2187
int stream_set_buffer(int fd, int sz)
Definition: network.c:2336
int openvas_SSL_init()
Initializes SSL support.
Definition: network.c:380
gnutls_session_t ovas_get_tlssession_from_connection(int fd)
Definition: network.c:422
int fd_is_stream(int fd)
Definition: network.c:2319
int nsend(int fd, void *data, int length, int i_opt)
Definition: network.c:1747
Definition: network.h:52
int read_stream_connection(int fd, void *buf0, int len)
Definition: network.c:1591
int port
Definition: ids_send.c:541
void add_close_stream_connection_hook(int(*fnc)(int fd))
Register a hook function for close_stream_connection.
Definition: network.c:1830
int socket_get_ssl_version(int fd)
Definition: network.c:833
int socket_get_ssl_compression(int fd)
Definition: network.c:914
void socket_get_cert(int fd, void **cert, int *certlen)
Definition: network.c:797
unsigned short * getpts(char *origexpr, int *len)
Converts a string like &quot;-100,200-1024,3000-4000,60000-&quot; into an array.
Definition: network.c:2589
Definition: network.h:51
int read_stream_connection_min(int fd, void *buf0, int min_len, int max_len)
Definition: network.c:1530
int internal_recv(int soc, char **data, int *data_sz, int *msg_type)
Definition: network.c:2491
int stream_get_buffer_sz(int fd)
Definition: network.c:2326
Definition: network.h:54
int nrecv(int fd, void *data, int length, int i_opt)
Definition: network.c:1788
openvas_encaps
Definition: network.h:44
int socket_get_ssl_ciphersuite(int fd)
Definition: network.c:954
int stream_zero(fd_set *set)
Definition: network.c:2303
int stream_get_err(int fd)
Definition: network.c:165
struct ovas_scanner_context_s * ovas_scanner_context_t
Definition: network.h:94
Definition: network.c:1143
int socket_negotiate_ssl(int fd, openvas_encaps_t transport, struct arglist *args)
Definition: network.c:762
Definition: arglists.h:29
int write_stream_connection(int fd, void *buf0, int n)
Definition: network.c:1741
Definition: network.h:46
int open_sock_opt_hn(const char *hostname, unsigned int port, int type, int protocol, int timeout)
Definition: network.c:2058
const char * get_encaps_through(openvas_encaps_t code)
Definition: network.c:1929
int internal_send(int soc, char *data, int msg_type)
Definition: network.c:2436
void socket_get_ssl_session_id(int fd, void **sid, size_t *ssize)
Definition: network.c:874
void ovas_scanner_context_free(ovas_scanner_context_t ctx)
Frees the ovas_scanner_context_t instance ctx.
Definition: network.c:1226
int timeout
Definition: ids_send.c:694
Definition: network.h:48
Definition: network.h:49
int get_sock_infos(int sock, int *r_transport, void **r_tls_session)
Definition: network.c:2549
int os_recv(int soc, void *buf, int len, int opt)
Definition: network.c:2406
int socket_close(int soc)
Definition: network.c:2293
openvas_encaps_t encaps
Definition: network.c:1146
int stream_set_timeout(int fd, int timeout)
Definition: network.c:1328
ovas_scanner_context_t ovas_scanner_context_new(openvas_encaps_t encaps, const char *certfile, const char *keyfile, const char *passwd, const char *cafile, const char *priority, const char *dhparams)
Creates a new ovas_scanner_context_t.
Definition: network.c:1167
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:1251
Definition: network.h:53
int close_stream_connection(int fd)
Definition: network.c:1869
Definition: network.h:45