[thirdparty/cups.git] / scheduler / client.h

/*
 * Client definitions for the CUPS scheduler.
 *
 * Copyright © 2020-2025 by OpenPrinting.
 * Copyright © 2007-2018 by Apple Inc.
 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
 *
 * Licensed under Apache License v2.0.  See the file "LICENSE" for more
 * information.
 */

#ifdef HAVE_AUTHORIZATION_H
#  include <Security/Authorization.h>
#endif /* HAVE_AUTHORIZATION_H */


/*
 * HTTP client structure...
 */

struct cupsd_client_s
{
  int			number;		/* Connection number */
  http_t		*http;		/* HTTP client connection */
  ipp_t			*request,	/* IPP request information */
			*response;	/* IPP response information */
  cupsd_location_t	*best;		/* Best match for AAA */
  struct timeval	start;		/* Request start time */
  http_state_t		operation;	/* Request operation */
  off_t			bytes;		/* Bytes transferred for this request */
  int			is_browser;	/* Is the client a web browser? */
  int			type;		/* AuthType for username */
  char			username[HTTP_MAX_VALUE],
					/* Username from Authorization: line */
			password[HTTP_MAX_VALUE],
					/* Password from Authorization: line */
			email[HTTP_MAX_VALUE],
					/* EMail from OAuth Bearer token */
			realname[HTTP_MAX_VALUE],
					/* Real name from OAuth Bearer token */
		      	autherror[HTTP_MAX_VALUE],
					/* Authorization error, if any */
			uri[2048],	/* Localized URL/URI for GET/PUT */
			*filename,	/* Filename of output file */
			*command,	/* Command to run */
			*options,	/* Options for command */
			*query_string;	/* QUERY_STRING environment variable */
  int			file;		/* Input/output file */
  int			file_ready;	/* Input ready on file/pipe? */
  int			bg_pending;	/* Background response pending? */
  cupsd_printer_t	*bg_printer;	/* Background printer */
  int			pipe_pid;	/* Pipe process ID (or 0 if not a pipe) */
  http_status_t		pipe_status;	/* HTTP status from pipe process */
  int			sent_header,	/* Non-zero if sent HTTP header */
			got_fields,	/* Non-zero if all fields seen */
			header_used;	/* Number of header bytes used */
  char			header[4096];	/* Header from CGI program */
  cups_lang_t		*language;	/* Language to use */
  int			auto_ssl;	/* Automatic test for SSL/TLS */
  http_addr_t		clientaddr;	/* Client's server address */
  char			clientname[256];/* Client's server name for connection */
  int			clientport;	/* Client's server port for connection */
  char			servername[256];/* Server name for connection */
  int			serverport;	/* Server port for connection */
#ifdef HAVE_GSSAPI
  int			have_gss;	/* Have GSS credentials? */
  uid_t			gss_uid;	/* User ID for local prints */
#endif /* HAVE_GSSAPI */
#ifdef HAVE_AUTHORIZATION_H
  AuthorizationRef	authref;	/* Authorization ref */
#endif /* HAVE_AUTHORIZATION_H */
};

#define HTTP(con) ((con)->http)


/*
 * HTTP listener structure...
 */

typedef struct
{
  int			fd;		/* File descriptor for this server */
  http_addr_t		address;	/* Bind address of socket */
  http_encryption_t	encryption;	/* To encrypt or not to encrypt... */
#ifdef HAVE_ONDEMAND
  int			on_demand;	/* Is this a socket from launchd/systemd/upstart? */
#endif /* HAVE_ONDEMAND */
} cupsd_listener_t;


/*
 * Globals...
 */

VAR int			LastClientNumber VALUE(0),
					/* Last client connection number */
			LocalPort	VALUE(631),
					/* Local port to use */
			RemotePort	VALUE(0);
					/* Remote port to use */
VAR http_encryption_t	LocalEncryption	VALUE(HTTP_ENCRYPTION_IF_REQUESTED);
					/* Local port encryption to use */
VAR cups_array_t	*Listeners	VALUE(NULL);
					/* Listening sockets */
VAR time_t		ListeningPaused	VALUE(0);
					/* Time when listening was paused */
VAR cups_array_t	*Clients	VALUE(NULL),
					/* HTTP clients */
			*ActiveClients	VALUE(NULL);
					/* Active HTTP clients */
VAR char		*ServerHeader	VALUE(NULL);
					/* Server header in requests */
VAR int			CGIPipes[2]	VALUE2(-1,-1);
					/* Pipes for CGI error/debug output */
VAR cupsd_statbuf_t	*CGIStatusBuffer VALUE(NULL);
					/* Status buffer for pipes */


/*
 * Prototypes...
 */

extern void	cupsdAcceptClient(cupsd_listener_t *lis);
extern void	cupsdCloseAllClients(void);
extern int	cupsdCloseClient(cupsd_client_t *con);
extern void	cupsdDeleteAllListeners(void);
extern void	cupsdPauseListening(void);
extern int	cupsdProcessIPPRequest(cupsd_client_t *con);
extern void	cupsdReadClient(cupsd_client_t *con);
extern void	cupsdResumeListening(void);
extern int	cupsdSendCommand(cupsd_client_t *con, char *command,
		                 char *options, int root);
extern int	cupsdSendError(cupsd_client_t *con, http_status_t code,
		               int auth_type);
extern int	cupsdSendHeader(cupsd_client_t *con, http_status_t code,
		                char *type, int auth_type);
extern void	cupsdShutdownClient(cupsd_client_t *con);
extern void	cupsdStartListening(void);
extern void	cupsdStopListening(void);
extern void	cupsdUpdateCGI(void);
extern void	cupsdWriteClient(cupsd_client_t *con);

extern int	cupsdEndTLS(cupsd_client_t *con);
extern int	cupsdStartTLS(cupsd_client_t *con);
Commit	Line	Data
	1	/*
	2	* Client definitions for the CUPS scheduler.
	3	*
	4	* Copyright © 2020-2025 by OpenPrinting.
	5	* Copyright © 2007-2018 by Apple Inc.
	6	* Copyright © 1997-2007 by Easy Software Products, all rights reserved.
	7	*
	8	* Licensed under Apache License v2.0. See the file "LICENSE" for more
	9	* information.
	10	*/
	11
	12	#ifdef HAVE_AUTHORIZATION_H
	13	# include <Security/Authorization.h>
	14	#endif /* HAVE_AUTHORIZATION_H */
	15
	16
	17	/*
	18	* HTTP client structure...
	19	*/
	20
	21	struct cupsd_client_s
	22	{
	23	int number; /* Connection number */
	24	http_t http; / HTTP client connection */
	25	ipp_t request, / IPP request information */
	26	response; / IPP response information */
	27	cupsd_location_t best; / Best match for AAA */
	28	struct timeval start; /* Request start time */
	29	http_state_t operation; /* Request operation */
	30	off_t bytes; /* Bytes transferred for this request */
	31	int is_browser; /* Is the client a web browser? */
	32	int type; /* AuthType for username */
	33	char username[HTTP_MAX_VALUE],
	34	/* Username from Authorization: line */
	35	password[HTTP_MAX_VALUE],
	36	/* Password from Authorization: line */
	37	email[HTTP_MAX_VALUE],
	38	/* EMail from OAuth Bearer token */
	39	realname[HTTP_MAX_VALUE],
	40	/* Real name from OAuth Bearer token */
	41	autherror[HTTP_MAX_VALUE],
	42	/* Authorization error, if any */
	43	uri[2048], /* Localized URL/URI for GET/PUT */
	44	filename, / Filename of output file */
	45	command, / Command to run */
	46	options, / Options for command */
	47	query_string; / QUERY_STRING environment variable */
	48	int file; /* Input/output file */
	49	int file_ready; /* Input ready on file/pipe? */
	50	int bg_pending; /* Background response pending? */
	51	cupsd_printer_t bg_printer; / Background printer */
	52	int pipe_pid; /* Pipe process ID (or 0 if not a pipe) */
	53	http_status_t pipe_status; /* HTTP status from pipe process */
	54	int sent_header, /* Non-zero if sent HTTP header */
	55	got_fields, /* Non-zero if all fields seen */
	56	header_used; /* Number of header bytes used */
	57	char header[4096]; /* Header from CGI program */
	58	cups_lang_t language; / Language to use */
	59	int auto_ssl; /* Automatic test for SSL/TLS */
	60	http_addr_t clientaddr; /* Client's server address */
	61	char clientname[256];/* Client's server name for connection */
	62	int clientport; /* Client's server port for connection */
	63	char servername[256];/* Server name for connection */
	64	int serverport; /* Server port for connection */
	65	#ifdef HAVE_GSSAPI
	66	int have_gss; /* Have GSS credentials? */
	67	uid_t gss_uid; /* User ID for local prints */
	68	#endif /* HAVE_GSSAPI */
	69	#ifdef HAVE_AUTHORIZATION_H
	70	AuthorizationRef authref; /* Authorization ref */
	71	#endif /* HAVE_AUTHORIZATION_H */
	72	};
	73
	74	#define HTTP(con) ((con)->http)
	75
	76
	77	/*
	78	* HTTP listener structure...
	79	*/
	80
	81	typedef struct
	82	{
	83	int fd; /* File descriptor for this server */
	84	http_addr_t address; /* Bind address of socket */
	85	http_encryption_t encryption; /* To encrypt or not to encrypt... */
	86	#ifdef HAVE_ONDEMAND
	87	int on_demand; /* Is this a socket from launchd/systemd/upstart? */
	88	#endif /* HAVE_ONDEMAND */
	89	} cupsd_listener_t;
	90
	91
	92	/*
	93	* Globals...
	94	*/
	95
	96	VAR int LastClientNumber VALUE(0),
	97	/* Last client connection number */
	98	LocalPort VALUE(631),
	99	/* Local port to use */
	100	RemotePort VALUE(0);
	101	/* Remote port to use */
	102	VAR http_encryption_t LocalEncryption VALUE(HTTP_ENCRYPTION_IF_REQUESTED);
	103	/* Local port encryption to use */
	104	VAR cups_array_t *Listeners VALUE(NULL);
	105	/* Listening sockets */
	106	VAR time_t ListeningPaused VALUE(0);
	107	/* Time when listening was paused */
	108	VAR cups_array_t *Clients VALUE(NULL),
	109	/* HTTP clients */
	110	*ActiveClients VALUE(NULL);
	111	/* Active HTTP clients */
	112	VAR char *ServerHeader VALUE(NULL);
	113	/* Server header in requests */
	114	VAR int CGIPipes[2] VALUE2(-1,-1);
	115	/* Pipes for CGI error/debug output */
	116	VAR cupsd_statbuf_t *CGIStatusBuffer VALUE(NULL);
	117	/* Status buffer for pipes */
	118
	119
	120	/*
	121	* Prototypes...
	122	*/
	123
	124	extern void cupsdAcceptClient(cupsd_listener_t *lis);
	125	extern void cupsdCloseAllClients(void);
	126	extern int cupsdCloseClient(cupsd_client_t *con);
	127	extern void cupsdDeleteAllListeners(void);
	128	extern void cupsdPauseListening(void);
	129	extern int cupsdProcessIPPRequest(cupsd_client_t *con);
	130	extern void cupsdReadClient(cupsd_client_t *con);
	131	extern void cupsdResumeListening(void);
	132	extern int cupsdSendCommand(cupsd_client_t con, char command,
	133	char *options, int root);
	134	extern int cupsdSendError(cupsd_client_t *con, http_status_t code,
	135	int auth_type);
	136	extern int cupsdSendHeader(cupsd_client_t *con, http_status_t code,
	137	char *type, int auth_type);
	138	extern void cupsdShutdownClient(cupsd_client_t *con);
	139	extern void cupsdStartListening(void);
	140	extern void cupsdStopListening(void);
	141	extern void cupsdUpdateCGI(void);
	142	extern void cupsdWriteClient(cupsd_client_t *con);
	143
	144	extern int cupsdEndTLS(cupsd_client_t *con);
	145	extern int cupsdStartTLS(cupsd_client_t *con);