serverutils.h
Go to the documentation of this file.
/* Copyright (C) 2009-2021 Greenbone Networks GmbH
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef _GVM_SERVERUTILS_H
#define _GVM_SERVERUTILS_H
#include <glib.h> /* for gchar, gboolean, gint */
#include <gnutls/gnutls.h> /* for gnutls_session_t, gnutls_certificate_cred... */
#include <stdarg.h> /* for va_list */
#include <sys/param.h>
#ifdef __FreeBSD__
#include <netinet/in.h>
#endif
#include <netinet/ip.h>
typedef struct
{
int tls;
int socket;
gnutls_session_t session;
gnutls_certificate_credentials_t credentials;
gchar *username;
gchar *password;
gchar *host_string;
gchar *port_string;
gint port;
gboolean use_certs;
gchar *ca_cert;
gchar *pub_key;
gchar *priv_key;
} gvm_connection_t;
void
gvm_connection_free (gvm_connection_t *);
void
gvm_connection_close (gvm_connection_t *);
int gvm_server_verify (gnutls_session_t);
int
gvm_server_open (gnutls_session_t *, const char *, int);
int
gvm_server_open_verify (gnutls_session_t *, const char *, int, const char *,
const char *, const char *, int);
int
gvm_server_open_with_cert (gnutls_session_t *, const char *, int, const char *,
const char *, const char *);
int
gvm_server_close (int, gnutls_session_t);
int
gvm_server_attach (int, gnutls_session_t *);
int
gvm_server_sendf (gnutls_session_t *, const char *, ...)
__attribute__ ((format (printf, 2, 3)));
int
gvm_server_vsendf (gnutls_session_t *, const char *, va_list);
int
gvm_socket_vsendf (int, const char *, va_list);
int
gvm_server_sendf_xml (gnutls_session_t *, const char *, ...);
int
gvm_server_sendf_xml_quiet (gnutls_session_t *, const char *, ...);
int
gvm_connection_sendf_xml (gvm_connection_t *, const char *, ...);
int
gvm_connection_sendf_xml_quiet (gvm_connection_t *, const char *, ...);
int
gvm_connection_sendf (gvm_connection_t *, const char *, ...);
int
gvm_server_new (unsigned int, gchar *, gchar *, gchar *, gnutls_session_t *,
gnutls_certificate_credentials_t *);
int
gvm_server_new_mem (unsigned int, const char *, const char *, const char *,
gnutls_session_t *, gnutls_certificate_credentials_t *);
int
gvm_server_free (int, gnutls_session_t, gnutls_certificate_credentials_t);
int gvm_server_session_free (gnutls_session_t,
gnutls_certificate_credentials_t);
int
load_gnutls_file (const char *, gnutls_datum_t *);
void
unload_gnutls_file (gnutls_datum_t *);
int
set_gnutls_dhparams (gnutls_certificate_credentials_t, const char *);
#endif /* not _GVM_SERVERUTILS_H */
__attribute__
__attribute__((weak))
Definition: networking_tests.c:1015
gvm_connection_sendf
int gvm_connection_sendf(gvm_connection_t *, const char *,...)
Format and send a string to the server.
Definition: serverutils.c:845
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:1165
gvm_server_verify
int gvm_server_verify(gnutls_session_t)
Verify certificate.
Definition: serverutils.c:130
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:333
unload_gnutls_file
void unload_gnutls_file(gnutls_datum_t *)
Unloads a gnutls_datum_t struct's data.
Definition: serverutils.c:208
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:180
gvm_connection_close
void gvm_connection_close(gvm_connection_t *)
Close a server connection and its socket.
Definition: serverutils.c:526
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:1187
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:908
gvm_server_close
int gvm_server_close(int, gnutls_session_t)
Close a server connection and its socket.
Definition: serverutils.c:513
gvm_server_session_free
int gvm_server_session_free(gnutls_session_t, gnutls_certificate_credentials_t)
gvm_connection_free
void gvm_connection_free(gvm_connection_t *)
Free connection.
Definition: serverutils.c:111
gvm_server_vsendf
int int gvm_server_vsendf(gnutls_session_t *, const char *, va_list)
Send a string to the server.
Definition: serverutils.c:749
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:960
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:481
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:499
gvm_socket_vsendf
int gvm_socket_vsendf(int, const char *, va_list)
Send a string to the server.
Definition: serverutils.c:764
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:591
set_gnutls_dhparams
int set_gnutls_dhparams(gnutls_certificate_credentials_t, const char *)
Set a gnutls session's Diffie-Hellman parameters.
Definition: serverutils.c:1249
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:933
gvm_server_sendf
int gvm_server_sendf(gnutls_session_t *, const char *,...) __attribute__((format(printf
gvm_server_free
int gvm_server_free(int, gnutls_session_t, gnutls_certificate_credentials_t)
Cleanup a server session.
Definition: serverutils.c:1292
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:987
gvm_connection_t
Connection.
Definition: serverutils.h:44
gvm_connection_t::port
gint port
Port of server.
Definition: serverutils.h:53
gvm_connection_t::use_certs
gboolean use_certs
Whether to use certs.
Definition: serverutils.h:54
gvm_connection_t::username
gchar * username
Username with which to connect.
Definition: serverutils.h:49
gvm_connection_t::ca_cert
gchar * ca_cert
CA certificate.
Definition: serverutils.h:55
gvm_connection_t::password
gchar * password
Password for user with which to connect.
Definition: serverutils.h:50
gvm_connection_t::priv_key
gchar * priv_key
The private key.
Definition: serverutils.h:57
gvm_connection_t::port_string
gchar * port_string
Server port string.
Definition: serverutils.h:52
gvm_connection_t::tls
int tls
Whether uses TCP-TLS (vs UNIX socket).
Definition: serverutils.h:45
gvm_connection_t::pub_key
gchar * pub_key
The public key.
Definition: serverutils.h:56
gvm_connection_t::credentials
gnutls_certificate_credentials_t credentials
Credentials.
Definition: serverutils.h:48
gvm_connection_t::socket
int socket
Socket.
Definition: serverutils.h:46
gvm_connection_t::host_string
gchar * host_string
Server host string.
Definition: serverutils.h:51
gvm_connection_t::session
gnutls_session_t session
Session.
Definition: serverutils.h:47