push.h

Go to the documentation of this file.

/*
 *  OpenVPN -- An application to securely tunnel IP networks
 *             over a single TCP/UDP port, with support for SSL/TLS-based
 *             session authentication and key exchange,
 *             packet encryption, packet authentication, and
 *             packet compression.
 *
 *  Copyright (C) 2002-2025 OpenVPN Inc <sales@openvpn.net>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation.
 *
 *  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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PUSH_H
#define PUSH_H
 
#include "forward.h"
 
#define PUSH_MSG_ERROR            0
#define PUSH_MSG_REQUEST          1
#define PUSH_MSG_REPLY            2
#define PUSH_MSG_REQUEST_DEFERRED 3
#define PUSH_MSG_AUTH_FAILURE     4
#define PUSH_MSG_CONTINUATION     5
#define PUSH_MSG_ALREADY_REPLIED  6
#define PUSH_MSG_UPDATE           7
 
#define push_reply_cmd  "PUSH_REPLY"
#define push_update_cmd "PUSH_UPDATE"
 
/* Push-update options flags */
#define PUSH_OPT_TO_REMOVE (1 << 0)
#define PUSH_OPT_OPTIONAL  (1 << 1)
 
#ifdef ENABLE_MANAGEMENT
/* Push-update message sender modes */
typedef enum
{
    UPT_BROADCAST = 0,
    UPT_BY_CID = 1
} push_update_type;
#endif
 
int process_incoming_push_request(struct context *c);
 
int process_incoming_push_update(struct context *c, unsigned int permission_mask,
                                 unsigned int *option_types_found, struct buffer *buf,
                                 bool msg_sender);
 
int process_incoming_push_msg(struct context *c, const struct buffer *buffer,
                              bool honor_received_options, unsigned int permission_mask,
                              unsigned int *option_types_found);
 
bool send_push_request(struct context *c);
 
void receive_auth_failed(struct context *c, const struct buffer *buffer);
 
void server_pushed_signal(struct context *c, const struct buffer *buffer, const bool restart,
                          const int adv);
 
void receive_exit_message(struct context *c);
 
void server_pushed_info(const struct buffer *buffer, const int adv);
 
void receive_cr_response(struct context *c, const struct buffer *buffer);
 
void incoming_push_message(struct context *c, const struct buffer *buffer);
 
void clone_push_list(struct options *o);
 
void push_option(struct options *o, const char *opt, int msglevel);
 
void push_options(struct options *o, char **p, int msglevel, struct gc_arena *gc);
 
void push_reset(struct options *o);
 
void push_remove_option(struct options *o, const char *p);
 
void remove_iroutes_from_push_route_list(struct options *o);
 
void send_auth_failed(struct context *c, const char *client_reason);
 
bool send_auth_pending_messages(struct tls_multi *tls_multi, struct tls_session *session,
                                const char *extra, unsigned int timeout);
 
void send_restart(struct context *c, const char *kill_msg);
 
void send_push_reply_auth_token(struct tls_multi *multi);
 
void receive_auth_pending(struct context *c, const struct buffer *buffer);
 
#ifdef ENABLE_MANAGEMENT
int
send_push_update(struct multi_context *m, const void *target, const char *msg, const push_update_type type, const int push_bundle_size);
 
bool management_callback_send_push_update_broadcast(void *arg, const char *options);
 
bool management_callback_send_push_update_by_cid(void *arg, unsigned long cid, const char *options);
 
#endif /* ifdef ENABLE_MANAGEMENT*/
 
#endif /* ifndef PUSH_H */