Greenbone Vulnerability Management Libraries  22.8.0
serverutils.h
Go to the documentation of this file.
1 /* SPDX-FileCopyrightText: 2009-2023 Greenbone AG
2  *
3  * SPDX-License-Identifier: GPL-2.0-or-later
4  */
5 
14 #ifndef _GVM_SERVERUTILS_H
15 #define _GVM_SERVERUTILS_H
16 
17 #include <glib.h> /* for gchar, gboolean, gint */
18 #include <gnutls/gnutls.h> /* for gnutls_session_t, gnutls_certificate_cred... */
19 #include <stdarg.h> /* for va_list */
20 #include <sys/param.h>
21 #ifdef __FreeBSD__
22 #include <netinet/in.h>
23 #endif
24 #include <netinet/ip.h>
25 
29 typedef struct
30 {
31  int tls;
32  int socket;
33  gnutls_session_t session;
34  gnutls_certificate_credentials_t credentials;
35  gchar *username;
36  gchar *password;
37  gchar *host_string;
38  gchar *port_string;
39  gint port;
40  gboolean use_certs;
41  gchar *ca_cert;
42  gchar *pub_key;
43  gchar *priv_key;
45 
46 void
48 
49 void
51 
52 int gvm_server_verify (gnutls_session_t);
53 
54 int
55 gvm_server_open (gnutls_session_t *, const char *, int);
56 
57 int
58 gvm_server_open_verify (gnutls_session_t *, const char *, int, const char *,
59  const char *, const char *, int);
60 
61 int
62 gvm_server_open_with_cert (gnutls_session_t *, const char *, int, const char *,
63  const char *, const char *);
64 
65 int
66 gvm_server_close (int, gnutls_session_t);
67 
68 int
69 gvm_server_attach (int, gnutls_session_t *);
70 
71 int
72 gvm_server_sendf (gnutls_session_t *, const char *, ...)
73  __attribute__ ((format (printf, 2, 3)));
74 
75 int
76 gvm_server_vsendf (gnutls_session_t *, const char *, va_list);
77 int
78 gvm_socket_vsendf (int, const char *, va_list);
79 
80 int
81 gvm_server_sendf_xml (gnutls_session_t *, const char *, ...);
82 int
83 gvm_server_sendf_xml_quiet (gnutls_session_t *, const char *, ...);
84 
85 int
86 gvm_connection_sendf_xml (gvm_connection_t *, const char *, ...);
87 int
89 
90 int
91 gvm_connection_sendf (gvm_connection_t *, const char *, ...);
92 
93 int
94 gvm_server_new (unsigned int, gchar *, gchar *, gchar *, gnutls_session_t *,
95  gnutls_certificate_credentials_t *);
96 
97 int
98 gvm_server_new_mem (unsigned int, const char *, const char *, const char *,
99  gnutls_session_t *, gnutls_certificate_credentials_t *);
100 
101 int
102 gvm_server_free (int, gnutls_session_t, gnutls_certificate_credentials_t);
103 
104 int gvm_server_session_free (gnutls_session_t,
105  gnutls_certificate_credentials_t);
106 
107 int
108 load_gnutls_file (const char *, gnutls_datum_t *);
109 
110 void
111 unload_gnutls_file (gnutls_datum_t *);
112 
113 int
114 set_gnutls_dhparams (gnutls_certificate_credentials_t, const char *);
115 
116 #endif /* not _GVM_SERVERUTILS_H */
gvm_socket_vsendf
int gvm_socket_vsendf(int, const char *, va_list)
Send a string to the server.
Definition: serverutils.c:743
load_gnutls_file
int load_gnutls_file(const char *, gnutls_datum_t *)
Loads a file's data into gnutls_datum_t struct.
Definition: serverutils.c:161
set_gnutls_dhparams
int set_gnutls_dhparams(gnutls_certificate_credentials_t, const char *)
Set a gnutls session's Diffie-Hellman parameters.
Definition: serverutils.c:1228
gvm_server_new
int gvm_server_new(unsigned int, gchar *, gchar *, gchar *, gnutls_session_t *, gnutls_certificate_credentials_t *)
Make a session for connecting to a server.
Definition: serverutils.c:1144
gvm_connection_t::ca_cert
gchar * ca_cert
CA certificate.
Definition: serverutils.h:41
gvm_server_sendf_xml_quiet
int gvm_server_sendf_xml_quiet(gnutls_session_t *, const char *,...)
Format and send an XML string to the server.
Definition: serverutils.c:939
gvm_server_open_with_cert
int gvm_server_open_with_cert(gnutls_session_t *, const char *, int, const char *, const char *, const char *)
Connect to the server using a given host, port and cert.
Definition: serverutils.c:462
gvm_server_session_free
int gvm_server_session_free(gnutls_session_t, gnutls_certificate_credentials_t)
gvm_connection_t::priv_key
gchar * priv_key
The private key.
Definition: serverutils.h:43
gvm_server_attach
int gvm_server_attach(int, gnutls_session_t *)
Attach a socket to a session, and shake hands with the peer.
Definition: serverutils.c:570
gvm_connection_t::port
gint port
Port of server.
Definition: serverutils.h:39
gvm_connection_free
void gvm_connection_free(gvm_connection_t *)
Free connection.
Definition: serverutils.c:92
gvm_connection_sendf_xml
int gvm_connection_sendf_xml(gvm_connection_t *, const char *,...)
Format and send an XML string to the server.
Definition: serverutils.c:912
gvm_server_free
int gvm_server_free(int, gnutls_session_t, gnutls_certificate_credentials_t)
Cleanup a server session.
Definition: serverutils.c:1271
gvm_connection_t::pub_key
gchar * pub_key
The public key.
Definition: serverutils.h:42
gvm_connection_t::username
gchar * username
Username with which to connect.
Definition: serverutils.h:35
gvm_connection_sendf_xml_quiet
int gvm_connection_sendf_xml_quiet(gvm_connection_t *, const char *,...)
Format and send an XML string to the server.
Definition: serverutils.c:966
gvm_server_new_mem
int gvm_server_new_mem(unsigned int, const char *, const char *, const char *, gnutls_session_t *, gnutls_certificate_credentials_t *)
Make a session for connecting to a server, with certificates stored in memory.
Definition: serverutils.c:1166
gvm_server_sendf_xml
int gvm_server_sendf_xml(gnutls_session_t *, const char *,...)
Format and send an XML string to the server.
Definition: serverutils.c:887
gvm_connection_sendf
int gvm_connection_sendf(gvm_connection_t *, const char *,...)
Format and send a string to the server.
Definition: serverutils.c:824
gvm_connection_t::password
gchar * password
Password for user with which to connect.
Definition: serverutils.h:36
gvm_server_open
int gvm_server_open(gnutls_session_t *, const char *, int)
Connect to the server using a given host and port.
Definition: serverutils.c:480
gvm_connection_t::socket
int socket
Socket.
Definition: serverutils.h:32
gvm_connection_t::tls
int tls
Whether uses TCP-TLS (vs UNIX socket).
Definition: serverutils.h:31
gvm_server_sendf
int gvm_server_sendf(gnutls_session_t *, const char *,...) __attribute__((format(printf
__attribute__
__attribute__((weak))
Definition: networking_tests.c:1003
gvm_connection_t::credentials
gnutls_certificate_credentials_t credentials
Credentials.
Definition: serverutils.h:34
gvm_connection_t::use_certs
gboolean use_certs
Whether to use certs.
Definition: serverutils.h:40
unload_gnutls_file
void unload_gnutls_file(gnutls_datum_t *)
Unloads a gnutls_datum_t struct's data.
Definition: serverutils.c:189
gvm_server_vsendf
int int gvm_server_vsendf(gnutls_session_t *, const char *, va_list)
Send a string to the server.
Definition: serverutils.c:728
gvm_server_verify
int gvm_server_verify(gnutls_session_t)
Verify certificate.
Definition: serverutils.c:111
gvm_connection_t::host_string
gchar * host_string
Server host string.
Definition: serverutils.h:37
gvm_server_open_verify
int gvm_server_open_verify(gnutls_session_t *, const char *, int, const char *, const char *, const char *, int)
Connect to the server using a given host, port and cert.
Definition: serverutils.c:314
gvm_server_close
int gvm_server_close(int, gnutls_session_t)
Close a server connection and its socket.
Definition: serverutils.c:494
gvm_connection_t::session
gnutls_session_t session
Session.
Definition: serverutils.h:33
gvm_connection_t
Connection.
Definition: serverutils.h:30
gvm_connection_t::port_string
gchar * port_string
Server port string.
Definition: serverutils.h:38
gvm_connection_close
void gvm_connection_close(gvm_connection_t *)
Close a server connection and its socket.
Definition: serverutils.c:505