-/*
- * User, system, and password routines for CUPS.
- *
- * Copyright © 2020-2025 by OpenPrinting.
- * Copyright © 2007-2019 by Apple Inc.
- * Copyright © 1997-2006 by Easy Software Products.
- *
- * Licensed under Apache License v2.0. See the file "LICENSE" for more
- * information.
- */
+//
+// User, system, and password routines for CUPS.
+//
+// Copyright © 2021-2025 by OpenPrinting.
+// Copyright © 2007-2019 by Apple Inc.
+// Copyright © 1997-2006 by Easy Software Products.
+//
+// Licensed under Apache License v2.0. See the file "LICENSE" for more
+// information.
+//
#include "cups-private.h"
#include "debug-internal.h"
# include <pwd.h>
# include <termios.h>
# include <sys/utsname.h>
-#endif /* _WIN32 */
+#endif // _WIN32
#ifdef __APPLE__
# include <sys/sysctl.h>
-#endif /* __APPLE__ */
+#endif // __APPLE__
-/*
- * Local constants...
- */
+//
+// Local constants...
+//
#ifdef __APPLE__
# if TARGET_OS_OSX
# else
# define kCUPSPrintingPrefs CFSTR(".GlobalPreferences")
# define kPREFIX "AirPrint"
-# endif /* TARGET_OS_OSX */
+# endif // TARGET_OS_OSX
# define kDigestOptionsKey CFSTR(kPREFIX "DigestOptions")
# define kUserKey CFSTR(kPREFIX "User")
# define kUserAgentTokensKey CFSTR(kPREFIX "UserAgentTokens")
# define kSSLOptionsKey CFSTR(kPREFIX "SSLOptions")
# define kTrustOnFirstUseKey CFSTR(kPREFIX "TrustOnFirstUse")
# define kValidateCertsKey CFSTR(kPREFIX "ValidateCerts")
-/* Deprecated */
+// Deprecated */
# define kAllowRC4 CFSTR(kPREFIX "AllowRC4")
# define kAllowSSL3 CFSTR(kPREFIX "AllowSSL3")
# define kAllowDH CFSTR(kPREFIX "AllowDH")
-#endif /* __APPLE__ */
+#endif // __APPLE__
-#define _CUPS_PASSCHAR '*' /* Character that is echoed for password */
+#define _CUPS_PASSCHAR '*' // Character that is echoed for password
-/*
- * Local types...
- */
+//
+// Local types...
+//
-typedef struct _cups_client_conf_s /**** client.conf config data ****/
+typedef struct _cups_client_conf_s // client.conf config data
{
- _cups_digestoptions_t digestoptions; /* DigestOptions values */
- _cups_uatokens_t uatokens; /* UserAgentTokens values */
- int ssl_options, /* SSLOptions values */
- ssl_min_version,/* Minimum SSL/TLS version */
- ssl_max_version;/* Maximum SSL/TLS version */
- int trust_first, /* Trust on first use? */
- any_root, /* Allow any (e.g., self-signed) root */
- expired_certs, /* Allow expired certs */
- validate_certs; /* Validate certificates */
- http_encryption_t encryption; /* Encryption setting */
- char user[65], /* User name */
- server_name[256];
- /* Server hostname */
+ _cups_digestoptions_t digestoptions; // DigestOptions values
+ _cups_uatokens_t uatokens; // UserAgentTokens values
+ int ssl_options, // SSLOptions values
+ ssl_min_version,// Minimum SSL/TLS version
+ ssl_max_version;// Maximum SSL/TLS version
+ int trust_first, // Trust on first use?
+ any_root, // Allow any (e.g., self-signed) root
+ expired_certs, // Allow expired certs
+ validate_certs; // Validate certificates
+ http_encryption_t encryption; // Encryption setting
+ char user[65], // User name
+ server_name[256],
+ // Server hostname
+ browse_domains[1024],
+ // Browse domains
+ filter_location[1024],
+ // Filter location(s)
+ filter_type[256];
+ // Filter type(s)
#ifdef HAVE_GSSAPI
char gss_service_name[32];
- /* Kerberos service name */
-#endif /* HAVE_GSSAPI */
+ // Kerberos service name
+#endif // HAVE_GSSAPI
} _cups_client_conf_t;
-/*
- * Local functions...
- */
+//
+// Local functions...
+//
#ifdef __APPLE__
static int cups_apple_get_boolean(CFStringRef key, int *value);
static int cups_apple_get_string(CFStringRef key, char *value, size_t valsize);
-#endif /* __APPLE__ */
+#endif // __APPLE__
static int cups_boolean_value(const char *value);
static void cups_finalize_client_conf(_cups_client_conf_t *cc);
static void cups_init_client_conf(_cups_client_conf_t *cc);
static void cups_read_client_conf(cups_file_t *fp, _cups_client_conf_t *cc);
static void cups_set_default_ipp_port(_cups_globals_t *cg);
+static void cups_set_browse_domains(_cups_client_conf_t *cc, const char *value);
static void cups_set_digestoptions(_cups_client_conf_t *cc, const char *value);
static void cups_set_encryption(_cups_client_conf_t *cc, const char *value);
+static void cups_set_filter_location(_cups_client_conf_t *cc, const char *value);
+static void cups_set_filter_type(_cups_client_conf_t *cc, const char *value);
#ifdef HAVE_GSSAPI
static void cups_set_gss_service_name(_cups_client_conf_t *cc, const char *value);
-#endif /* HAVE_GSSAPI */
+#endif // HAVE_GSSAPI
static void cups_set_server_name(_cups_client_conf_t *cc, const char *value);
static void cups_set_ssl_options(_cups_client_conf_t *cc, const char *value);
static void cups_set_uatokens(_cups_client_conf_t *cc, const char *value);
static void cups_set_user(_cups_client_conf_t *cc, const char *value);
-/*
- * 'cupsEncryption()' - Get the current encryption settings.
- *
- * @deprecated@
- */
+//
+// Local globals...
+//
+
+static const char * const uatokens[] =// UserAgentTokens values
+{
+ "None",
+ "ProductOnly",
+ "Major",
+ "Minor",
+ "Minimal",
+ "OS",
+ "Full"
+};
+#ifdef DEBUG
+static const char * const tls_versions[] =
+{ // TLS/SSL version numbers
+ "SSL3.0",
+ "TLS1.0",
+ "TLS1.1",
+ "TLS1.2",
+ "TLS1.3",
+ "TLS1.3"
+};
+#endif // DEBUG
+
+
+//
+// 'cupsEncryption()' - Get the current encryption settings.
+//
+// @deprecated@
+//
-http_encryption_t /* O - Encryption settings */
+http_encryption_t // O - Encryption settings
cupsEncryption(void)
{
return (cupsGetEncryption());
}
-/*
- * 'cupsGetEncryption()' - Get the current encryption settings.
- *
- * The default encryption setting comes from the CUPS_ENCRYPTION
- * environment variable, then the ~/.cups/client.conf file, and finally the
- * /etc/cups/client.conf file. If not set, the default is
- * @code HTTP_ENCRYPTION_IF_REQUESTED@.
- *
- * Note: The current encryption setting is tracked separately for each thread
- * in a program. Multi-threaded programs that override the setting via the
- * @link cupsSetEncryption@ function need to do so in each thread for the same
- * setting to be used.
- *
- * @since CUPS 2.5@
- */
-
-http_encryption_t /* O - Encryption settings */
+//
+// 'cupsGetEncryption()' - Get the current encryption settings.
+//
+// The default encryption setting comes from the CUPS_ENCRYPTION
+// environment variable, then the ~/.cups/client.conf file, and finally the
+// /etc/cups/client.conf file. If not set, the default is
+// @code HTTP_ENCRYPTION_IF_REQUESTED@.
+//
+// Note: The current encryption setting is tracked separately for each thread
+// in a program. Multi-threaded programs that override the setting via the
+// @link cupsSetEncryption@ function need to do so in each thread for the same
+// setting to be used.
+//
+// @since CUPS 2.5@
+//
+
+http_encryption_t // O - Encryption settings
cupsGetEncryption(void)
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
- if (cg->encryption == (http_encryption_t)-1)
+ if (!cg->client_conf_loaded)
_cupsSetDefaults();
return (cg->encryption);
}
-/*
- * 'cupsGetPassword()' - Get a password from the user.
- *
- * Uses the current password callback function. Returns @code NULL@ if the
- * user does not provide a password.
- *
- * Note: The current password callback function is tracked separately for each
- * thread in a program. Multi-threaded programs that override the setting via
- * the @link cupsSetPasswordCB@ or @link cupsSetPasswordCB2@ functions need to
- * do so in each thread for the same function to be used.
- *
- * @exclude all@
- */
-
-const char * /* O - Password */
-cupsGetPassword(const char *prompt) /* I - Prompt string */
+//
+// 'cupsGetPassword()' - Get a password from the user.
+//
+// Uses the current password callback function. Returns @code NULL@ if the
+// user does not provide a password.
+//
+// Note: The current password callback function is tracked separately for each
+// thread in a program. Multi-threaded programs that override the setting via
+// the @link cupsSetPasswordCB@ or @link cupsSetPasswordCB2@ functions need to
+// do so in each thread for the same function to be used.
+//
+// @exclude all@
+//
+
+const char * // O - Password
+cupsGetPassword(const char *prompt) // I - Prompt string
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
return ((cg->password_cb)(prompt, NULL, NULL, NULL, cg->password_data));
}
-/*
- * 'cupsGetPassword2()' - Get a password from the user using the current
- * password callback.
- *
- * Uses the current password callback function. Returns @code NULL@ if the
- * user does not provide a password.
- *
- * Note: The current password callback function is tracked separately for each
- * thread in a program. Multi-threaded programs that override the setting via
- * the @link cupsSetPasswordCB2@ function need to do so in each thread for the
- * same function to be used.
- *
- * @since CUPS 1.4@
- */
-
-const char * /* O - Password */
-cupsGetPassword2(const char *prompt, /* I - Prompt string */
- http_t *http, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
- const char *method, /* I - Request method ("GET", "POST", "PUT") */
- const char *resource) /* I - Resource path */
+//
+// 'cupsGetPassword2()' - Get a password from the user using the current
+// password callback.
+//
+// Uses the current password callback function. Returns @code NULL@ if the
+// user does not provide a password.
+//
+// Note: The current password callback function is tracked separately for each
+// thread in a program. Multi-threaded programs that override the setting via
+// the @link cupsSetPasswordCB2@ function need to do so in each thread for the
+// same function to be used.
+//
+// @since CUPS 1.4@
+//
+
+const char * // O - Password
+cupsGetPassword2(const char *prompt, // I - Prompt string
+ http_t *http, // I - Connection to server or @code CUPS_HTTP_DEFAULT@
+ const char *method, // I - Request method ("GET", "POST", "PUT")
+ const char *resource) // I - Resource path
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
if (!http)
}
-/*
- * 'cupsGetServer()' - Return the hostname/address of the current server.
- *
- * The default server comes from the CUPS_SERVER environment variable, then the
- * ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not
- * set, the default is the local system - either "localhost" or a domain socket
- * path.
- *
- * The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6
- * address, or a domain socket pathname.
- *
- * Note: The current server is tracked separately for each thread in a program.
- * Multi-threaded programs that override the server via the
- * @link cupsSetServer@ function need to do so in each thread for the same
- * server to be used.
- *
- * @since CUPS 2.5@
- */
-
-const char * /* O - Server name */
+//
+// 'cupsGetServer()' - Return the hostname/address of the current server.
+//
+// The default server comes from the CUPS_SERVER environment variable, then the
+// ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not
+// set, the default is the local system - either "localhost" or a domain socket
+// path.
+//
+// The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6
+// address, or a domain socket pathname.
+//
+// Note: The current server is tracked separately for each thread in a program.
+// Multi-threaded programs that override the server via the
+// @link cupsSetServer@ function need to do so in each thread for the same
+// server to be used.
+//
+// @since CUPS 2.5@
+//
+
+const char * // O - Server name
cupsGetServer(void)
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
- if (!cg->server[0])
+ if (!cg->client_conf_loaded)
_cupsSetDefaults();
return (cg->server);
}
-/*
- * 'cupsGetUser()' - Return the current user's name.
- *
- * Note: The current user name is tracked separately for each thread in a
- * program. Multi-threaded programs that override the user name with the
- * @link cupsSetUser@ function need to do so in each thread for the same user
- * name to be used.
- *
- * @since CUPS 2.5@
- */
+//
+// 'cupsGetUser()' - Return the current user's name.
+//
+// Note: The current user name is tracked separately for each thread in a
+// program. Multi-threaded programs that override the user name with the
+// @link cupsSetUser@ function need to do so in each thread for the same user
+// name to be used.
+//
+// @since CUPS 2.5@
+//
-const char * /* O - User name */
+const char * // O - User name
cupsGetUser(void)
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
- if (!cg->user[0])
+ if (!cg->client_conf_loaded)
_cupsSetDefaults();
return (cg->user);
}
-/*
- * 'cupsGetUserAgent()' - Return the default HTTP User-Agent string.
- *
- * @since CUPS 2.5@
- */
+//
+// 'cupsGetUserAgent()' - Return the default HTTP User-Agent string.
+//
+// @since CUPS 2.5@
+//
-const char * /* O - User-Agent string */
+const char * // O - User-Agent string
cupsGetUserAgent(void)
{
- _cups_globals_t *cg = _cupsGlobals(); /* Thread globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Thread globals
if (!cg->user_agent[0])
}
-/*
- * 'cupsServer()' - Return the hostname/address of the current server.
- *
- * The default server comes from the CUPS_SERVER environment variable, then the
- * ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not
- * set, the default is the local system - either "localhost" or a domain socket
- * path.
- *
- * The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6
- * address, or a domain socket pathname.
- *
- * Note: The current server is tracked separately for each thread in a program.
- * Multi-threaded programs that override the server via the
- * @link cupsSetServer@ function need to do so in each thread for the same
- * server to be used.
- *
- * @deprecated@
- */
-
-const char * /* O - Server name */
+//
+// 'cupsServer()' - Return the hostname/address of the current server.
+//
+// The default server comes from the CUPS_SERVER environment variable, then the
+// ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not
+// set, the default is the local system - either "localhost" or a domain socket
+// path.
+//
+// The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6
+// address, or a domain socket pathname.
+//
+// Note: The current server is tracked separately for each thread in a program.
+// Multi-threaded programs that override the server via the
+// @link cupsSetServer@ function need to do so in each thread for the same
+// server to be used.
+//
+// @deprecated@
+//
+
+const char * // O - Server name
cupsServer(void)
{
return (cupsGetServer());
}
-/*
- * 'cupsSetClientCertCB()' - Set the client certificate callback.
- *
- * Pass @code NULL@ to restore the default callback.
- *
- * Note: The current certificate callback is tracked separately for each thread
- * in a program. Multi-threaded programs that override the callback need to do
- * so in each thread for the same callback to be used.
- *
- * @deprecated@
- */
+//
+// 'cupsSetClientCertCB()' - Set the client certificate callback.
+//
+// Pass @code NULL@ to restore the default callback.
+//
+// Note: The current certificate callback is tracked separately for each thread
+// in a program. Multi-threaded programs that override the callback need to do
+// so in each thread for the same callback to be used.
+//
+// @deprecated@
+//
void
cupsSetClientCertCB(
- cups_client_cert_cb_t cb, /* I - Callback function */
- void *user_data) /* I - User data pointer */
+ cups_client_cert_cb_t cb, // I - Callback function
+ void *user_data) // I - User data pointer
{
(void)cb;
(void)user_data;
}
-/*
- * 'cupsSetCredentials()' - Set the default credentials to be used for SSL/TLS
- * connections.
- *
- * @deprecated@
- */
+//
+// 'cupsSetCredentials()' - Set the default credentials to be used for SSL/TLS
+// connections.
+//
+// @deprecated@
+//
-int /* O - Status of call (0 = success) */
+int // O - Status of call (0 = success)
cupsSetCredentials(
- cups_array_t *credentials) /* I - Array of credentials */
+ cups_array_t *credentials) // I - Array of credentials
{
(void)credentials;
}
-/*
- * 'cupsSetEncryption()' - Set the encryption preference.
- *
- * The default encryption setting comes from the CUPS_ENCRYPTION
- * environment variable, then the ~/.cups/client.conf file, and finally the
- * /etc/cups/client.conf file. If not set, the default is
- * @code HTTP_ENCRYPTION_IF_REQUESTED@.
- *
- * Note: The current encryption setting is tracked separately for each thread
- * in a program. Multi-threaded programs that override the setting need to do
- * so in each thread for the same setting to be used.
- */
+//
+// 'cupsSetEncryption()' - Set the encryption preference.
+//
+// The default encryption setting comes from the CUPS_ENCRYPTION
+// environment variable, then the ~/.cups/client.conf file, and finally the
+// /etc/cups/client.conf file. If not set, the default is
+// @code HTTP_ENCRYPTION_IF_REQUESTED@.
+//
+// Note: The current encryption setting is tracked separately for each thread
+// in a program. Multi-threaded programs that override the setting need to do
+// so in each thread for the same setting to be used.
+//
void
-cupsSetEncryption(http_encryption_t e) /* I - New encryption preference */
+cupsSetEncryption(http_encryption_t e) // I - New encryption preference
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
cg->encryption = e;
}
-/*
- * 'cupsSetOAuthCB()' - Set the OAuth 2.0 callback for CUPS.
- *
- * This function sets the OAuth 2.0 callback for the various CUPS APIs that
- * send HTTP requests. Pass @code NULL@ to restore the default (console-based)
- * callback.
- *
- * The OAuth callback receives the HTTP connection, realm name, scope name (if
- * any), resource path, and the "user_data" pointer for each request that
- * requires an OAuth access token. The function then returns either the Bearer
- * token string or `NULL` if no authorization could be obtained.
- *
- * Beyond reusing the Bearer token for subsequent requests on the same HTTP
- * connection, no caching of the token is done by the CUPS library. The
- * callback can determine whether to refresh a cached token by examining any
- * existing token returned by the @link httpGetAuthString@ function.
- *
- * Note: The current OAuth callback is tracked separately for each thread in a
- * program. Multi-threaded programs that override the callback need to do so in
- * each thread for the same callback to be used.
- *
- * @since CUPS 2.4@
- */
+//
+// 'cupsSetOAuthCB()' - Set the OAuth 2.0 callback for CUPS.
+//
+// This function sets the OAuth 2.0 callback for the various CUPS APIs that
+// send HTTP requests. Pass @code NULL@ to restore the default (console-based)
+// callback.
+//
+// The OAuth callback receives the HTTP connection, realm name, scope name (if
+// any), resource path, and the "user_data" pointer for each request that
+// requires an OAuth access token. The function then returns either the Bearer
+// token string or `NULL` if no authorization could be obtained.
+//
+// Beyond reusing the Bearer token for subsequent requests on the same HTTP
+// connection, no caching of the token is done by the CUPS library. The
+// callback can determine whether to refresh a cached token by examining any
+// existing token returned by the @link httpGetAuthString@ function.
+//
+// Note: The current OAuth callback is tracked separately for each thread in a
+// program. Multi-threaded programs that override the callback need to do so in
+// each thread for the same callback to be used.
+//
+// @since CUPS 2.4@
+//
void
cupsSetOAuthCB(
- cups_oauth_cb_t cb, /* I - Callback function */
- void *user_data) /* I - User data pointer */
+ cups_oauth_cb_t cb, // I - Callback function
+ void *user_data) // I - User data pointer
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
cg->oauth_cb = cb;
}
-/*
- * 'cupsSetPasswordCB()' - Set the password callback for CUPS.
- *
- * Pass @code NULL@ to restore the default (console) password callback, which
- * reads the password from the console. Programs should call either this
- * function or @link cupsSetPasswordCB2@, as only one callback can be registered
- * by a program per thread.
- *
- * Note: The current password callback is tracked separately for each thread
- * in a program. Multi-threaded programs that override the callback need to do
- * so in each thread for the same callback to be used.
- *
- * @exclude all@
- */
+//
+// 'cupsSetPasswordCB()' - Set the password callback for CUPS.
+//
+// Pass @code NULL@ to restore the default (console) password callback, which
+// reads the password from the console. Programs should call either this
+// function or @link cupsSetPasswordCB2@, as only one callback can be registered
+// by a program per thread.
+//
+// Note: The current password callback is tracked separately for each thread
+// in a program. Multi-threaded programs that override the callback need to do
+// so in each thread for the same callback to be used.
+//
+// @exclude all@
+//
void
-cupsSetPasswordCB(cups_password_cb_t cb)/* I - Callback function */
+cupsSetPasswordCB(cups_password_cb_t cb)// I - Callback function
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
if (cb == (cups_password_cb_t)0)
}
-/*
- * 'cupsSetPasswordCB2()' - Set the advanced password callback for CUPS.
- *
- * Pass @code NULL@ to restore the default (console) password callback, which
- * reads the password from the console. Programs should call either this
- * function or @link cupsSetPasswordCB2@, as only one callback can be registered
- * by a program per thread.
- *
- * Note: The current password callback is tracked separately for each thread
- * in a program. Multi-threaded programs that override the callback need to do
- * so in each thread for the same callback to be used.
- *
- * @since CUPS 1.4@
- */
+//
+// 'cupsSetPasswordCB2()' - Set the advanced password callback for CUPS.
+//
+// Pass @code NULL@ to restore the default (console) password callback, which
+// reads the password from the console. Programs should call either this
+// function or @link cupsSetPasswordCB2@, as only one callback can be registered
+// by a program per thread.
+//
+// Note: The current password callback is tracked separately for each thread
+// in a program. Multi-threaded programs that override the callback need to do
+// so in each thread for the same callback to be used.
+//
+// @since CUPS 1.4@
+//
void
cupsSetPasswordCB2(
- cups_password_cb2_t cb, /* I - Callback function */
- void *user_data) /* I - User data pointer */
+ cups_password_cb2_t cb, // I - Callback function
+ void *user_data) // I - User data pointer
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
if (cb == (cups_password_cb2_t)0)
}
-/*
- * 'cupsSetServer()' - Set the default server name and port.
- *
- * The "server" string can be a fully-qualified hostname, a numeric
- * IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP
- * addresses can be optionally followed by a colon and port number to override
- * the default port 631, e.g. "hostname:8631". Pass @code NULL@ to restore the
- * default server name and port.
- *
- * Note: The current server is tracked separately for each thread in a program.
- * Multi-threaded programs that override the server need to do so in each
- * thread for the same server to be used.
- */
+//
+// 'cupsSetServer()' - Set the default server name and port.
+//
+// The "server" string can be a fully-qualified hostname, a numeric
+// IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP
+// addresses can be optionally followed by a colon and port number to override
+// the default port 631, e.g. "hostname:8631". Pass @code NULL@ to restore the
+// default server name and port.
+//
+// Note: The current server is tracked separately for each thread in a program.
+// Multi-threaded programs that override the server need to do so in each
+// thread for the same server to be used.
+//
void
-cupsSetServer(const char *server) /* I - Server name */
+cupsSetServer(const char *server) // I - Server name
{
- char *options, /* Options */
- *port; /* Pointer to port */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ char *options, // Options
+ *port; // Pointer to port
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
if (server)
}
-/*
- * 'cupsSetServerCertCB()' - Set the server certificate callback.
- *
- * Pass @code NULL@ to restore the default callback.
- *
- * Note: The current credentials callback is tracked separately for each thread
- * in a program. Multi-threaded programs that override the callback need to do
- * so in each thread for the same callback to be used.
- *
- * @deprecated@
- */
+//
+// 'cupsSetServerCertCB()' - Set the server certificate callback.
+//
+// Pass @code NULL@ to restore the default callback.
+//
+// Note: The current credentials callback is tracked separately for each thread
+// in a program. Multi-threaded programs that override the callback need to do
+// so in each thread for the same callback to be used.
+//
+// @deprecated@
+//
void
cupsSetServerCertCB(
- cups_server_cert_cb_t cb, /* I - Callback function */
- void *user_data) /* I - User data pointer */
+ cups_server_cert_cb_t cb, // I - Callback function
+ void *user_data) // I - User data pointer
{
(void)cb;
(void)user_data;
}
-/*
- * 'cupsSetUser()' - Set the default user name.
- *
- * Pass @code NULL@ to restore the default user name.
- *
- * Note: The current user name is tracked separately for each thread in a
- * program. Multi-threaded programs that override the user name need to do so
- * in each thread for the same user name to be used.
- */
+//
+// 'cupsSetUser()' - Set the default user name.
+//
+// Pass @code NULL@ to restore the default user name.
+//
+// Note: The current user name is tracked separately for each thread in a
+// program. Multi-threaded programs that override the user name need to do so
+// in each thread for the same user name to be used.
+//
void
-cupsSetUser(const char *user) /* I - User name */
+cupsSetUser(const char *user) // I - User name
{
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
if (user)
}
-/*
- * 'cupsSetUserAgent()' - Set the default HTTP User-Agent string.
- *
- * Setting the string to NULL forces the default value containing the CUPS
- * version, IPP version, and operating system version and architecture.
- *
- * @since CUPS 1.7@
- */
+//
+// 'cupsSetUserAgent()' - Set the default HTTP User-Agent string.
+//
+// Setting the string to NULL forces the default value containing the CUPS
+// version, IPP version, and operating system version and architecture.
+//
+// @since CUPS 1.7@
+//
void
-cupsSetUserAgent(const char *user_agent)/* I - User-Agent string or @code NULL@ */
+cupsSetUserAgent(const char *user_agent)// I - User-Agent string or @code NULL@
{
_cups_globals_t *cg = _cupsGlobals();
- /* Thread globals */
+ // Thread globals
#ifdef _WIN32
- SYSTEM_INFO sysinfo; /* System information */
- OSVERSIONINFOW version; /* OS version info */
- const char *machine; /* Hardware/machine name */
+ SYSTEM_INFO sysinfo; // System information
+ OSVERSIONINFOW version; // OS version info
+ const char *machine; // Hardware/machine name
#elif defined(__APPLE__)
- struct utsname name; /* uname info */
- char version[256]; /* macOS/iOS version */
- size_t len; /* Length of value */
+ struct utsname name; // uname info
+ char version[256]; // macOS/iOS version
+ size_t len; // Length of value
#else
- struct utsname name; /* uname info */
-#endif /* _WIN32 */
+ struct utsname name; // uname info
+#endif // _WIN32
if (user_agent)
}
#ifdef _WIN32
- /*
- * Gather Windows version information for the User-Agent string...
- */
-
+ // Gather Windows version information for the User-Agent string...
typedef NTSTATUS(WINAPI * RtlGetVersionPtr)(PRTL_OSVERSIONINFOW);
memset(&version, 0, sizeof(version));
version.dwOSVersionInfoSize = sizeof(version);
- /* RtlGetVersion gets the current native version of Windows, even when running in compatibility mode */
+ // RtlGetVersion gets the current native version of Windows, even when running in compatibility mode
RtlGetVersionPtr RtlGetVersionInternal = (RtlGetVersionPtr)GetProcAddress(GetModuleHandleW(L"ntdll.dll"), "RtlGetVersion");
if (RtlGetVersionInternal)
{
}
else
{
- /* Should not happen, but just in case, fallback to deprecated GetVersionExW */
+ // Should not happen, but just in case, fallback to deprecated GetVersionExW
GetVersionExW(&version);
}
GetNativeSystemInfo(&sysinfo);
snprintf(cg->user_agent, sizeof(cg->user_agent), CUPS_MINIMAL " (Windows %lu.%lu; %s) IPP/2.0", version.dwMajorVersion, version.dwMinorVersion, machine);
#elif defined(__APPLE__)
- /*
- * Gather macOS/iOS version information for the User-Agent string...
- */
-
+ // Gather macOS/iOS version information for the User-Agent string...
uname(&name);
len = sizeof(version) - 1;
snprintf(cg->user_agent, sizeof(cg->user_agent), CUPS_MINIMAL " (iOS %s) IPP/2.0", version);
else
snprintf(cg->user_agent, sizeof(cg->user_agent), CUPS_MINIMAL " (iOS %s; %s) IPP/2.0", version, name.machine);
-# endif /* TARGET_OS_OSX */
+# endif // TARGET_OS_OSX
#else
- /*
- * Gather generic UNIX version information for the User-Agent string...
- */
-
+ // Gather generic UNIX version information for the User-Agent string...
uname(&name);
if (cg->uatokens == _CUPS_UATOKENS_OS)
snprintf(cg->user_agent, sizeof(cg->user_agent), CUPS_MINIMAL " (%s %s) IPP/2.0", name.sysname, name.release);
else
snprintf(cg->user_agent, sizeof(cg->user_agent), CUPS_MINIMAL " (%s %s; %s) IPP/2.0", name.sysname, name.release, name.machine);
-#endif /* _WIN32 */
+#endif // _WIN32
}
-/*
- * 'cupsUser()' - Return the current user's name.
- *
- * Note: The current user name is tracked separately for each thread in a
- * program. Multi-threaded programs that override the user name with the
- * @link cupsSetUser@ function need to do so in each thread for the same user
- * name to be used.
- *
- * @deprecated@
- */
+//
+// 'cupsUser()' - Return the current user's name.
+//
+// Note: The current user name is tracked separately for each thread in a
+// program. Multi-threaded programs that override the user name with the
+// @link cupsSetUser@ function need to do so in each thread for the same user
+// name to be used.
+//
+// @deprecated@
+//
-const char * /* O - User name */
+const char * // O - User name
cupsUser(void)
{
return (cupsGetUser());
}
-/*
- * 'cupsUserAgent()' - Return the default HTTP User-Agent string.
- *
- * @deprecated@
- */
+//
+// 'cupsUserAgent()' - Return the default HTTP User-Agent string.
+//
+// @deprecated@
+//
-const char * /* O - User-Agent string */
+const char * // O - User-Agent string
cupsUserAgent(void)
{
return (cupsGetUserAgent());
}
-/*
- * '_cupsGetPassword()' - Get a password from the user.
- */
+//
+// '_cupsGetPassword()' - Get a password from the user.
+//
-const char * /* O - Password or @code NULL@ if none */
-_cupsGetPassword(const char *prompt) /* I - Prompt string */
+const char * // O - Password or @code NULL@ if none
+_cupsGetPassword(const char *prompt) // I - Prompt string
{
#ifdef _WIN32
- HANDLE tty; /* Console handle */
- DWORD mode; /* Console mode */
- char passch, /* Current key press */
- *passptr, /* Pointer into password string */
- *passend; /* End of password string */
- DWORD passbytes; /* Bytes read */
+ HANDLE tty; // Console handle
+ DWORD mode; // Console mode
+ char passch, // Current key press
+ *passptr, // Pointer into password string
+ *passend; // End of password string
+ DWORD passbytes; // Bytes read
_cups_globals_t *cg = _cupsGlobals();
- /* Thread globals */
-
+ // Thread globals
- /*
- * Disable input echo and set raw input...
- */
+ // Disable input echo and set raw input...
if ((tty = GetStdHandle(STD_INPUT_HANDLE)) == INVALID_HANDLE_VALUE)
return (NULL);
if (!SetConsoleMode(tty, 0))
return (NULL);
- /*
- * Display the prompt...
- */
-
+ // Display the prompt...
printf("%s ", prompt);
fflush(stdout);
- /*
- * Read the password string from /dev/tty until we get interrupted or get a
- * carriage return or newline...
- */
-
+ // Read the password string from /dev/tty until we get interrupted or get a
+ // carriage return or newline...
passptr = cg->password;
passend = cg->password + sizeof(cg->password) - 1;
{
if (passch == 0x0A || passch == 0x0D)
{
- /*
- * Enter/return...
- */
-
+ // Enter/return...
break;
}
else if (passch == 0x08 || passch == 0x7F)
{
- /*
- * Backspace/delete (erase character)...
- */
-
+ // Backspace/delete (erase character)...
if (passptr > cg->password)
{
passptr --;
}
else if (passch == 0x15)
{
- /*
- * CTRL+U (erase line)
- */
-
+ // CTRL+U (erase line)
if (passptr > cg->password)
{
while (passptr > cg->password)
}
else if (passch == 0x03)
{
- /*
- * CTRL+C...
- */
-
+ // CTRL+C...
passptr = cg->password;
break;
}
putchar('\n');
fflush(stdout);
- /*
- * Cleanup...
- */
+ // Cleanup...
SetConsoleMode(tty, mode);
- /*
- * Return the proper value...
- */
-
+ // Return the proper value...
if (passbytes == 1 && passptr > cg->password)
{
*passptr = '\0';
}
#else
- int tty; /* /dev/tty - never read from stdin */
- struct termios original, /* Original input mode */
- noecho; /* No echo input mode */
- char passch, /* Current key press */
- *passptr, /* Pointer into password string */
- *passend; /* End of password string */
- ssize_t passbytes; /* Bytes read */
+ int tty; // /dev/tty - never read from stdin
+ struct termios original, // Original input mode
+ noecho; // No echo input mode
+ char passch, // Current key press
+ *passptr, // Pointer into password string
+ *passend; // End of password string
+ ssize_t passbytes; // Bytes read
_cups_globals_t *cg = _cupsGlobals();
- /* Thread globals */
-
+ // Thread globals
- /*
- * Disable input echo and set raw input...
- */
+ // Disable input echo and set raw input...
if ((tty = open("/dev/tty", O_RDONLY)) < 0)
return (NULL);
return (NULL);
}
- /*
- * Display the prompt...
- */
-
+ // Display the prompt...
printf("%s ", prompt);
fflush(stdout);
- /*
- * Read the password string from /dev/tty until we get interrupted or get a
- * carriage return or newline...
- */
-
+ // Read the password string from /dev/tty until we get interrupted or get a
+ // carriage return or newline...
passptr = cg->password;
passend = cg->password + sizeof(cg->password) - 1;
if (passch == noecho.c_cc[VEOL] ||
# ifdef VEOL2
passch == noecho.c_cc[VEOL2] ||
-# endif /* VEOL2 */
+# endif // VEOL2
passch == 0x0A || passch == 0x0D)
{
- /*
- * Enter/return...
- */
-
+ // Enter/return...
break;
}
else if (passch == noecho.c_cc[VERASE] ||
passch == 0x08 || passch == 0x7F)
{
- /*
- * Backspace/delete (erase character)...
- */
-
+ // Backspace/delete (erase character)...
if (passptr > cg->password)
{
passptr --;
}
else if (passch == noecho.c_cc[VKILL])
{
- /*
- * CTRL+U (erase line)
- */
-
+ // CTRL+U (erase line)
if (passptr > cg->password)
{
while (passptr > cg->password)
else if (passch == noecho.c_cc[VINTR] || passch == noecho.c_cc[VQUIT] ||
passch == noecho.c_cc[VEOF])
{
- /*
- * CTRL+C, CTRL+D, or CTRL+Z...
- */
-
+ // CTRL+C, CTRL+D, or CTRL+Z...
passptr = cg->password;
break;
}
putchar('\n');
fflush(stdout);
- /*
- * Cleanup...
- */
-
+ // Cleanup...
tcsetattr(tty, TCSAFLUSH, &original);
close(tty);
- /*
- * Return the proper value...
- */
-
+ // Return the proper value...
if (passbytes == 1 && passptr > cg->password)
{
*passptr = '\0';
memset(cg->password, 0, sizeof(cg->password));
return (NULL);
}
-#endif /* _WIN32 */
+#endif // _WIN32
}
#ifdef HAVE_GSSAPI
-/*
- * '_cupsGSSServiceName()' - Get the GSS (Kerberos) service name.
- */
+//
+// '_cupsGSSServiceName()' - Get the GSS (Kerberos) service name.
+//
const char *
_cupsGSSServiceName(void)
{
- _cups_globals_t *cg = _cupsGlobals(); /* Thread globals */
+ _cups_globals_t *cg = _cupsGlobals(); // Thread globals
if (!cg->gss_service_name[0])
return (cg->gss_service_name);
}
-#endif /* HAVE_GSSAPI */
+#endif // HAVE_GSSAPI
-/*
- * '_cupsSetDefaults()' - Set the default server, port, and encryption.
- */
+//
+// '_cupsSetDefaults()' - Set the default server, port, and encryption.
+//
void
_cupsSetDefaults(void)
{
- cups_file_t *fp; /* File */
- char filename[1024]; /* Filename */
- _cups_client_conf_t cc; /* client.conf values */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ cups_file_t *fp; // File
+ char filename[1024]; // Filename
+ _cups_client_conf_t cc; // client.conf values
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
+#ifdef DEBUG
+ static const char * const encryptions[] =
+ { // Encryption values
+ "IfRequested",
+ "Never",
+ "Required",
+ "Always"
+ };
+#endif // DEBUG
DEBUG_puts("_cupsSetDefaults()");
- /*
- * Load initial client.conf values...
- */
-
+ // Load initial client.conf values...
cups_init_client_conf(&cc);
- /*
- * Read the /etc/cups/client.conf and ~/.cups/client.conf files, if
- * present.
- */
-
+ // Read the /etc/cups/client.conf and ~/.cups/client.conf files, if
+ // present.
snprintf(filename, sizeof(filename), "%s/client.conf", cg->sysconfig);
if ((fp = cupsFileOpen(filename, "r")) != NULL)
{
if (cg->userconfig)
{
- /*
- * Look for ~/.cups/client.conf...
- */
-
+ // Look for ~/.cups/client.conf...
snprintf(filename, sizeof(filename), "%s/client.conf", cg->userconfig);
if ((fp = cupsFileOpen(filename, "r")) != NULL)
}
}
- /*
- * Finalize things so every client.conf value is set...
- */
-
+ // Finalize things so every client.conf value is set...
cups_finalize_client_conf(&cc);
cg->uatokens = cc.uatokens;
#ifdef HAVE_GSSAPI
if (!cg->gss_service_name[0])
cupsCopyString(cg->gss_service_name, cc.gss_service_name, sizeof(cg->gss_service_name));
-#endif /* HAVE_GSSAPI */
+#endif // HAVE_GSSAPI
if (cg->trust_first < 0)
cg->trust_first = cc.trust_first;
if (cg->validate_certs < 0)
cg->validate_certs = cc.validate_certs;
+ DEBUG_printf("1_cupsSetDefaults: BrowseDomains %s", cc.browse_domains);
+
+ if (!strcmp(cc.browse_domains, "none"))
+ cg->browse_domains = cupsArrayNewStrings(/*s*/NULL, /*delim*/'\0');
+ else if (strcmp(cc.browse_domains, "all") && cc.browse_domains[0])
+ cg->browse_domains = cupsArrayNewStrings(cc.browse_domains, /*delim*/',');
+
+ DEBUG_printf("1_cupsSetDefaults: FilterLocation %s", cc.filter_location);
+
+ if (cc.filter_location[0] == '/')
+ {
+ // FilterLocation /regex/
+ if ((cg->filter_location_regex = (regex_t *)calloc(1, sizeof(regex_t))) != NULL)
+ {
+ char *ptr = cc.filter_location + strlen(cc.filter_location) - 1;
+ // Pointer into FilterLocation value
+
+ if (*ptr == '/')
+ *ptr = '\0'; // Strip trailing '/'
+
+ if (regcomp(cg->filter_location_regex, cc.filter_location + 1, REG_EXTENDED | REG_ICASE))
+ {
+ DEBUG_puts("1_cupsSetDefaults: Bad regular expression in FilterLocation - results not filtered.");
+ free(cg->filter_location_regex);
+ cg->filter_location_regex = NULL;
+ }
+ }
+ }
+ else if (cc.filter_location[0])
+ {
+ // FilterLocation "string"[,...,"string"]
+ // FilterLocation 'string'[,...,'string']
+ // FilterLocation string[,...,string]
+ char quote, // Quote character, if any
+ *start, // Start of value
+ *ptr; // Pointer into string
+
+ cg->filter_location_array = cupsArrayNewStrings(/*s*/NULL, /*delim*/'\0');
+
+ // Scan for strings...
+ for (ptr = cc.filter_location; *ptr;)
+ {
+ // Handle quotes...
+ if (*ptr == '\'' || *ptr == '\"')
+ quote = *ptr++;
+ else
+ quote = '\0';
+
+ // Find the end of the string...
+ for (start = ptr; *ptr; ptr ++)
+ {
+ if (quote && *ptr == quote)
+ {
+ *ptr++ = '\0';
+ if (*ptr == ',')
+ *ptr++ = '\0';
+ break;
+ }
+ else if (!quote && *ptr == ',')
+ {
+ *ptr++ = '\0';
+ break;
+ }
+ }
+
+ if (*start)
+ cupsArrayAdd(cg->filter_location_array, start);
+ }
+ }
+
+ DEBUG_printf("1_cupsSetDefaults: FilterType %s", cc.filter_type);
+ if (cc.filter_type[0] && strcmp(cc.filter_type, "any"))
+ {
+ char *ptr, // Pointer into type value
+ *next; // Pointer to next value
+
+ for (ptr = cc.filter_type; ptr && *ptr; ptr = next)
+ {
+ if ((next = strchr(ptr, ',')) != NULL)
+ *next++ = '\0';
+
+ if (!_cups_strcasecmp(ptr, "mono"))
+ {
+ cg->filter_type |= CUPS_PTYPE_BW;
+ cg->filter_type_mask |= CUPS_PTYPE_BW;
+ }
+ else if (!_cups_strcasecmp(ptr, "color"))
+ {
+ cg->filter_type |= CUPS_PTYPE_COLOR;
+ cg->filter_type_mask |= CUPS_PTYPE_COLOR;
+ }
+ else if (!_cups_strcasecmp(ptr, "duplex"))
+ {
+ if (cg->filter_type_mask & CUPS_PTYPE_DUPLEX)
+ {
+ // Both simplex and duplex
+ cg->filter_type_mask &= (cups_ptype_t)~CUPS_PTYPE_DUPLEX;
+ }
+ else
+ {
+ // Just duplex
+ cg->filter_type |= CUPS_PTYPE_DUPLEX;
+ cg->filter_type_mask |= CUPS_PTYPE_DUPLEX;
+ }
+ }
+ else if (!_cups_strcasecmp(ptr, "simplex"))
+ {
+ if (cg->filter_type & CUPS_PTYPE_DUPLEX)
+ {
+ // Both simplex and duplex
+ cg->filter_type_mask &= (cups_ptype_t)~CUPS_PTYPE_DUPLEX;
+ }
+ else
+ {
+ // Just simplex
+ cg->filter_type_mask |= CUPS_PTYPE_DUPLEX;
+ }
+ }
+ else if (!_cups_strcasecmp(ptr, "staple"))
+ {
+ cg->filter_type |= CUPS_PTYPE_STAPLE;
+ cg->filter_type_mask |= CUPS_PTYPE_STAPLE;
+ }
+ else if (!_cups_strcasecmp(ptr, "punch"))
+ {
+ cg->filter_type |= CUPS_PTYPE_PUNCH;
+ cg->filter_type_mask |= CUPS_PTYPE_PUNCH;
+ }
+ else if (!_cups_strcasecmp(ptr, "cover"))
+ {
+ cg->filter_type |= CUPS_PTYPE_COVER;
+ cg->filter_type_mask |= CUPS_PTYPE_COVER;
+ }
+ else if (!_cups_strcasecmp(ptr, "bind"))
+ {
+ cg->filter_type |= CUPS_PTYPE_BIND;
+ cg->filter_type_mask |= CUPS_PTYPE_BIND;
+ }
+ else if (!_cups_strcasecmp(ptr, "sort"))
+ {
+ cg->filter_type |= CUPS_PTYPE_SORT;
+ cg->filter_type_mask |= CUPS_PTYPE_SORT;
+ }
+ else if (!_cups_strcasecmp(ptr, "small"))
+ {
+ cg->filter_type |= CUPS_PTYPE_SMALL;
+ cg->filter_type_mask |= CUPS_PTYPE_SMALL;
+ }
+ else if (!_cups_strcasecmp(ptr, "medium"))
+ {
+ cg->filter_type |= CUPS_PTYPE_MEDIUM;
+ cg->filter_type_mask |= CUPS_PTYPE_MEDIUM;
+ }
+ else if (!_cups_strcasecmp(ptr, "large"))
+ {
+ cg->filter_type |= CUPS_PTYPE_LARGE;
+ cg->filter_type_mask |= CUPS_PTYPE_LARGE;
+ }
+ else if (!_cups_strcasecmp(ptr, "variable"))
+ {
+ cg->filter_type |= CUPS_PTYPE_VARIABLE;
+ cg->filter_type_mask |= CUPS_PTYPE_VARIABLE;
+ }
+ else
+ {
+ // Something we don't understand...
+ DEBUG_printf("2_cupsSetDefaults: Unknown FilterType '%s'.", ptr);
+ }
+ }
+ }
+
+ DEBUG_printf("1_cupsSetDefaults: FilterType value 0x%x mask 0x%x", cg->filter_type, cg->filter_type_mask);
+
+ DEBUG_printf("1_cupsSetDefaults: AllowAnyRoot %s", cg->any_root ? "Yes" : "No");
+ DEBUG_printf("1_cupsSetDefaults: AllowExpiredCerts %s", cg->expired_certs ? "Yes" : "No");
+ DEBUG_printf("1_cupsSetDefaults: DigestOptions %s", cg->digestoptions == _CUPS_DIGESTOPTIONS_DENYMD5 ? "DenyMD5" : "None");
+ DEBUG_printf("1_cupsSetDefaults: Encryption %s", encryptions[cg->encryption]);
+ DEBUG_printf("1_cupsSetDefaults: ServerName %s", cg->servername);
+ DEBUG_printf("1_cupsSetDefaults: SSLOptions%s%s%s%s Min%s Max%s", cc.ssl_options == _HTTP_TLS_NONE ? " none" : "", (cc.ssl_options & _HTTP_TLS_ALLOW_RC4) ? " AllowRC4" : "", (cc.ssl_options & _HTTP_TLS_ALLOW_DH) ? " AllowDH" : "", (cc.ssl_options & _HTTP_TLS_DENY_CBC) ? " DenyCBC" : "", tls_versions[cc.ssl_min_version], tls_versions[cc.ssl_max_version]);
+ DEBUG_printf("1_cupsSetDefaults: TrustOnFirstUse %s", cg->trust_first ? "Yes" : "No");
+ DEBUG_printf("1_cupsSetDefaults: User %s", cg->user);
+ DEBUG_printf("1_cupsSetDefaults: UserAgentTokens %s", uatokens[cg->uatokens]);
+ DEBUG_printf("1_cupsSetDefaults: ValidateCerts %s", cg->validate_certs ? "Yes" : "No");
+
_httpTLSSetOptions(cc.ssl_options | _HTTP_TLS_SET_DEFAULT, cc.ssl_min_version, cc.ssl_max_version);
+
+ cg->client_conf_loaded = true;
}
#ifdef __APPLE__
-/*
- * 'cups_apple_get_boolean()' - Get a boolean setting from the CUPS preferences.
- */
+//
+// 'cups_apple_get_boolean()' - Get a boolean setting from the CUPS preferences.
+//
-static int /* O - 1 if set, 0 otherwise */
+static int // O - 1 if set, 0 otherwise
cups_apple_get_boolean(
- CFStringRef key, /* I - Key (name) */
- int *value) /* O - Boolean value */
+ CFStringRef key, // I - Key (name)
+ int *value) // O - Boolean value
{
- Boolean bval, /* Preference value */
- bval_set; /* Value is set? */
+ Boolean bval, // Preference value
+ bval_set; // Value is set?
bval = CFPreferencesGetAppBooleanValue(key, kCUPSPrintingPrefs, &bval_set);
}
-/*
- * 'cups_apple_get_string()' - Get a string setting from the CUPS preferences.
- */
+//
+// 'cups_apple_get_string()' - Get a string setting from the CUPS preferences.
+//
-static int /* O - 1 if set, 0 otherwise */
+static int // O - 1 if set, 0 otherwise
cups_apple_get_string(
- CFStringRef key, /* I - Key (name) */
- char *value, /* O - String value */
- size_t valsize) /* I - Size of value buffer */
+ CFStringRef key, // I - Key (name)
+ char *value, // O - String value
+ size_t valsize) // I - Size of value buffer
{
- CFStringRef sval; /* String value */
+ CFStringRef sval; // String value
if ((sval = CFPreferencesCopyAppValue(key, kCUPSPrintingPrefs)) != NULL)
return (0);
}
-#endif /* __APPLE__ */
+#endif // __APPLE__
-/*
- * 'cups_boolean_value()' - Convert a string to a boolean value.
- */
+//
+// 'cups_boolean_value()' - Convert a string to a boolean value.
+//
-static int /* O - Boolean value */
-cups_boolean_value(const char *value) /* I - String value */
+static int // O - Boolean value
+cups_boolean_value(const char *value) // I - String value
{
return (!_cups_strcasecmp(value, "yes") || !_cups_strcasecmp(value, "on") || !_cups_strcasecmp(value, "true"));
}
-/*
- * 'cups_finalize_client_conf()' - Finalize client.conf values.
- */
+//
+// 'cups_finalize_client_conf()' - Finalize client.conf values.
+//
static void
cups_finalize_client_conf(
- _cups_client_conf_t *cc) /* I - client.conf values */
+ _cups_client_conf_t *cc) // I - client.conf values
{
- const char *value; /* Environment variable */
+ const char *value; // Environment variable
+ if ((value = getenv("CUPS_BROWSE_DOMAINS")) != NULL)
+ cups_set_browse_domains(cc, value);
+
+ if ((value = getenv("CUPS_FILTER_LOCATION")) != NULL)
+ cups_set_filter_location(cc, value);
+
+ if ((value = getenv("CUPS_FILTER_TYPE")) != NULL)
+ cups_set_filter_type(cc, value);
+
if ((value = getenv("CUPS_TRUSTFIRST")) != NULL)
cc->trust_first = cups_boolean_value(value);
#ifdef HAVE_GSSAPI
if ((value = getenv("CUPS_GSSSERVICENAME")) != NULL)
cups_set_gss_service_name(cc, value);
-#endif /* HAVE_GSSAPI */
+#endif // HAVE_GSSAPI
if ((value = getenv("CUPS_SERVER")) != NULL)
cups_set_server_name(cc, value);
if ((value = getenv("CUPS_VALIDATECERTS")) != NULL)
cc->validate_certs = cups_boolean_value(value);
- /*
- * Then apply defaults for those values that haven't been set...
- */
-
+ // Then apply defaults for those values that haven't been set...
if (cc->trust_first < 0)
cc->trust_first = 1;
#ifdef HAVE_GSSAPI
if (!cc->gss_service_name[0])
cups_set_gss_service_name(cc, CUPS_DEFAULT_GSSSERVICENAME);
-#endif /* HAVE_GSSAPI */
+#endif // HAVE_GSSAPI
if (!cc->server_name[0])
{
- /*
- * If we are compiled with domain socket support, only use the
- * domain socket if it exists and has the right permissions...
- */
-
+ // If we are compiled with domain socket support, only use the
+ // domain socket if it exists and has the right permissions...
#if defined(__APPLE__) && !TARGET_OS_OSX
cups_set_server_name(cc, "/private/var/run/printd");
if (!access(CUPS_DEFAULT_DOMAINSOCKET, R_OK))
cups_set_server_name(cc, CUPS_DEFAULT_DOMAINSOCKET);
else
-# endif /* CUPS_DEFAULT_DOMAINSOCKET */
+# endif // CUPS_DEFAULT_DOMAINSOCKET
cups_set_server_name(cc, "localhost");
-#endif /* __APPLE__ && !TARGET_OS_OSX */
+#endif // __APPLE__ && !TARGET_OS_OSX
}
if (!cc->user[0])
{
#ifdef _WIN32
- /*
- * Get the current user name from the OS...
- */
-
- DWORD size; /* Size of string */
+ // Get the current user name from the OS...
+ DWORD size; // Size of string
size = sizeof(cc->user);
if (!GetUserNameA(cc->user, &size))
#else
- /*
- * Try the USER environment variable as the default username...
- */
-
- const char *envuser = getenv("USER"); /* Default username */
- struct passwd pw; /* Account information */
- struct passwd *result = NULL; /* Auxiliary pointer */
- _cups_globals_t *cg = _cupsGlobals(); /* Pointer to library globals */
+ // Try the USER environment variable as the default username...
+ const char *envuser = getenv("USER"); // Default username
+ struct passwd pw; // Account information
+ struct passwd *result = NULL; // Auxiliary pointer
+ _cups_globals_t *cg = _cupsGlobals(); // Pointer to library globals
if (envuser)
{
- /*
- * Validate USER matches the current UID, otherwise don't allow it to
- * override things... This makes sure that printing after doing su
- * or sudo records the correct username.
- */
+ // Validate USER matches the current UID, otherwise don't allow it to
+ // override things... This makes sure that printing after doing su
+ // or sudo records the correct username.
getpwnam_r(envuser, &pw, cg->pw_buf, PW_BUF_SIZE, &result);
if (result && pw.pw_uid != getuid())
result = NULL;
if (result)
cupsCopyString(cc->user, pw.pw_name, sizeof(cc->user));
else
-#endif /* _WIN32 */
+#endif // _WIN32
{
- /*
- * Use the default "unknown" user name...
- */
-
+ // Use the default "unknown" user name...
cupsCopyString(cc->user, "unknown", sizeof(cc->user));
}
}
}
-/*
- * 'cups_init_client_conf()' - Initialize client.conf values.
- */
+//
+// 'cups_init_client_conf()' - Initialize client.conf values.
+//
static void
cups_init_client_conf(
- _cups_client_conf_t *cc) /* I - client.conf values */
+ _cups_client_conf_t *cc) // I - client.conf values
{
- /*
- * Clear all values to "not set"...
- */
-
+ // Clear all values to "not set"...
memset(cc, 0, sizeof(_cups_client_conf_t));
cc->uatokens = _CUPS_UATOKENS_MINIMAL;
#if defined(__APPLE__) && !TARGET_OS_OSX
cups_set_user(cc, "mobile");
-#endif /* __APPLE__ && !TARGET_OS_OSX */
+#endif // __APPLE__ && !TARGET_OS_OSX
cc->ssl_min_version = _HTTP_TLS_1_0;
cc->ssl_max_version = _HTTP_TLS_MAX;
cc->expired_certs = -1;
cc->validate_certs = -1;
- /*
- * Load settings from the org.cups.PrintingPrefs plist (which trump
- * everything...)
- */
-
+ // Load settings from the org.cups.PrintingPrefs plist (which trump
+ // everything...)
#if defined(__APPLE__)
- char sval[1024]; /* String value */
- int bval; /* Boolean value */
+ char sval[1024]; // String value
+ int bval; // Boolean value
if (cups_apple_get_boolean(kAllowAnyRootKey, &bval))
cc->any_root = bval;
if (cups_apple_get_string(kUserAgentTokensKey, sval, sizeof(sval)))
cups_set_uatokens(cc, sval);
-#endif /* __APPLE__ */
+#endif // __APPLE__
}
-/*
- * 'cups_read_client_conf()' - Read a client.conf file.
- */
+//
+// 'cups_read_client_conf()' - Read a client.conf file.
+//
static void
cups_read_client_conf(
- cups_file_t *fp, /* I - File to read */
- _cups_client_conf_t *cc) /* I - client.conf values */
+ cups_file_t *fp, // I - File to read
+ _cups_client_conf_t *cc) // I - client.conf values
{
- int linenum; /* Current line number */
- char line[1024], /* Line from file */
- *value; /* Pointer into line */
+ int linenum; // Current line number
+ char line[1024], // Line from file
+ *value; // Pointer into line
- /*
- * Read from the file...
- */
-
+ // Read from the file...
linenum = 0;
while (cupsFileGetConf(fp, line, sizeof(line), &value, &linenum))
{
- if (!_cups_strcasecmp(line, "DigestOptions") && value)
+ if (!_cups_strcasecmp(line, "BrowseDomains"))
+ cups_set_browse_domains(cc, value);
+ else if (!_cups_strcasecmp(line, "DigestOptions") && value)
cups_set_digestoptions(cc, value);
else if (!_cups_strcasecmp(line, "Encryption") && value)
cups_set_encryption(cc, value);
+ else if (!_cups_strcasecmp(line, "FilterLocation"))
+ cups_set_filter_location(cc, value);
+ else if (!_cups_strcasecmp(line, "FilterType"))
+ cups_set_filter_type(cc, value);
#ifndef __APPLE__
- /*
- * The ServerName directive is not supported on macOS due to app
- * sandboxing restrictions, i.e. not all apps request network access.
- */
+ // The ServerName directive is not supported on macOS due to app
+ // sandboxing restrictions, i.e. not all apps request network access.
else if (!_cups_strcasecmp(line, "ServerName") && value)
cups_set_server_name(cc, value);
-#endif /* !__APPLE__ */
+#endif // !__APPLE__
else if (!_cups_strcasecmp(line, "User") && value)
cups_set_user(cc, value);
else if (!_cups_strcasecmp(line, "UserAgentTokens") && value)
#ifdef HAVE_GSSAPI
else if (!_cups_strcasecmp(line, "GSSServiceName") && value)
cups_set_gss_service_name(cc, value);
-#endif /* HAVE_GSSAPI */
+#endif // HAVE_GSSAPI
else if (!_cups_strcasecmp(line, "SSLOptions") && value)
cups_set_ssl_options(cc, value);
}
}
-/*
- * 'cups_set_default_ipp_port()' - Set the default IPP port value.
- */
+//
+// 'cups_set_browse_domains()' - Set the BrowseDomains value.
+//
+
+static void
+cups_set_browse_domains(
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
+{
+ if (value)
+ cupsCopyString(cc->browse_domains, value, sizeof(cc->browse_domains));
+ else
+ cc->browse_domains[0] = '\0';
+}
+
+
+//
+// 'cups_set_default_ipp_port()' - Set the default IPP port value.
+//
static void
cups_set_default_ipp_port(
- _cups_globals_t *cg) /* I - Global data */
+ _cups_globals_t *cg) // I - Global data
{
- const char *ipp_port; /* IPP_PORT environment variable */
+ const char *ipp_port; // IPP_PORT environment variable
if ((ipp_port = getenv("IPP_PORT")) != NULL)
}
-/*
- * 'cups_set_digestoptions()' - Set the DigestOptions value.
- */
+//
+// 'cups_set_digestoptions()' - Set the DigestOptions value.
+//
static void
cups_set_digestoptions(
- _cups_client_conf_t *cc, /* I - client.conf values */
- const char *value) /* I - Value */
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
{
if (!_cups_strcasecmp(value, "DenyMD5"))
cc->digestoptions = _CUPS_DIGESTOPTIONS_DENYMD5;
}
-/*
- * 'cups_set_encryption()' - Set the Encryption value.
- */
+//
+// 'cups_set_encryption()' - Set the Encryption value.
+//
static void
cups_set_encryption(
- _cups_client_conf_t *cc, /* I - client.conf values */
- const char *value) /* I - Value */
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
{
if (!_cups_strcasecmp(value, "never"))
cc->encryption = HTTP_ENCRYPTION_NEVER;
}
-/*
- * 'cups_set_gss_service_name()' - Set the GSSServiceName value.
- */
+//
+// 'cups_set_gss_service_name()' - Set the GSSServiceName value.
+//
#ifdef HAVE_GSSAPI
static void
cups_set_gss_service_name(
- _cups_client_conf_t *cc, /* I - client.conf values */
- const char *value) /* I - Value */
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
{
cupsCopyString(cc->gss_service_name, value, sizeof(cc->gss_service_name));
}
-#endif /* HAVE_GSSAPI */
+#endif // HAVE_GSSAPI
-/*
- * 'cups_set_server_name()' - Set the ServerName value.
- */
+//
+// 'cups_set_filter_location()' - Set the FilterLocation value.
+//
+
+static void
+cups_set_filter_location(
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
+{
+ if (value)
+ cupsCopyString(cc->filter_location, value, sizeof(cc->filter_location));
+ else
+ cc->filter_location[0] = '\0';
+}
+
+
+//
+// 'cups_set_filter_type()' - Set the FilterType value.
+//
+
+static void
+cups_set_filter_type(
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
+{
+ if (value)
+ cupsCopyString(cc->filter_type, value, sizeof(cc->filter_type));
+ else
+ cc->filter_type[0] = '\0';
+}
+
+
+//
+// 'cups_set_server_name()' - Set the ServerName value.
+//
static void
cups_set_server_name(
- _cups_client_conf_t *cc, /* I - client.conf values */
- const char *value) /* I - Value */
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
{
cupsCopyString(cc->server_name, value, sizeof(cc->server_name));
}
-/*
- * 'cups_set_ssl_options()' - Set the SSLOptions value.
- */
+//
+// 'cups_set_ssl_options()' - Set the SSLOptions value.
+//
static void
cups_set_ssl_options(
- _cups_client_conf_t *cc, /* I - client.conf values */
- const char *value) /* I - Value */
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
{
- /*
- * SSLOptions [AllowRC4] [AllowSSL3] [AllowDH] [DenyTLS1.0] [None]
- */
-
- int options = _HTTP_TLS_NONE, /* SSL/TLS options */
- min_version = _HTTP_TLS_1_0, /* Minimum SSL/TLS version */
- max_version = _HTTP_TLS_MAX; /* Maximum SSL/TLS version */
- char temp[256], /* Copy of value */
- *start, /* Start of option */
- *end; /* End of option */
+ // SSLOptions [AllowRC4] [AllowSSL3] [AllowDH] [DenyTLS1.0] [None]
+ int options = _HTTP_TLS_NONE, // SSL/TLS options
+ min_version = _HTTP_TLS_1_0, // Minimum SSL/TLS version
+ max_version = _HTTP_TLS_MAX; // Maximum SSL/TLS version
+ char temp[256], // Copy of value
+ *start, // Start of option
+ *end; // End of option
cupsCopyString(temp, value, sizeof(temp));
for (start = temp; *start; start = end)
{
- /*
- * Find end of keyword...
- */
-
+ // Find end of keyword...
end = start;
while (*end && !_cups_isspace(*end))
end ++;
if (*end)
*end++ = '\0';
- /*
- * Compare...
- */
-
+ // Compare...
if (!_cups_strcasecmp(start, "AllowRC4"))
options |= _HTTP_TLS_ALLOW_RC4;
else if (!_cups_strcasecmp(start, "AllowSSL3"))
}
-/*
- * 'cups_set_uatokens()' - Set the UserAgentTokens value.
- */
+//
+// 'cups_set_uatokens()' - Set the UserAgentTokens value.
+//
static void
cups_set_uatokens(
- _cups_client_conf_t *cc, /* I - client.conf values */
- const char *value) /* I - Value */
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
{
- int i; /* Looping var */
- static const char * const uatokens[] =/* UserAgentTokens values */
- {
- "NONE",
- "PRODUCTONLY",
- "MAJOR",
- "MINOR",
- "MINIMAL",
- "OS",
- "FULL"
- };
+ int i; // Looping var
+
for (i = 0; i < (int)(sizeof(uatokens) / sizeof(uatokens[0])); i ++)
{
}
-/*
- * 'cups_set_user()' - Set the User value.
- */
+//
+// 'cups_set_user()' - Set the User value.
+//
static void
cups_set_user(
- _cups_client_conf_t *cc, /* I - client.conf values */
- const char *value) /* I - Value */
+ _cups_client_conf_t *cc, // I - client.conf values
+ const char *value) // I - Value
{
cupsCopyString(cc->user, value, sizeof(cc->user));
}
projects / thirdparty / cups.git / commitdiff
