xref: /aosp_15_r20/external/libcups/doc/help/man-client.conf.html (revision 5e7646d21f1134fb0638875d812ef646c12ab91e)
1*5e7646d2SAndroid Build Coastguard Worker<!DOCTYPE HTML>
2*5e7646d2SAndroid Build Coastguard Worker<html>
3*5e7646d2SAndroid Build Coastguard Worker<!-- SECTION: Man Pages -->
4*5e7646d2SAndroid Build Coastguard Worker<head>
5*5e7646d2SAndroid Build Coastguard Worker	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
6*5e7646d2SAndroid Build Coastguard Worker	<title>client.conf(5)</title>
7*5e7646d2SAndroid Build Coastguard Worker</head>
8*5e7646d2SAndroid Build Coastguard Worker<body>
9*5e7646d2SAndroid Build Coastguard Worker<h1 class="title">client.conf(5)</h1>
10*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="NAME">Name</a></h2>
11*5e7646d2SAndroid Build Coastguard Workerclient.conf - client configuration file for cups (deprecated on macos)
12*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13*5e7646d2SAndroid Build Coastguard WorkerThe <b>client.conf</b> file configures the CUPS client and is normally located in the <i>/etc/cups</i> and/or <i>~/.cups</i> directories.
14*5e7646d2SAndroid Build Coastguard WorkerEach line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
15*5e7646d2SAndroid Build Coastguard Worker<p><b>Note:</b> Starting with macOS 10.7, this file is only used by command-line and X11 applications plus the IPP backend.
16*5e7646d2SAndroid Build Coastguard WorkerThe <b>ServerName</b> directive is not supported on macOS at all.
17*5e7646d2SAndroid Build Coastguard WorkerStarting with macOS 10.12, all applications can access these settings in the <i>/Library/Preferences/org.cups.PrintingPrefs.plist</i> file instead.
18*5e7646d2SAndroid Build Coastguard WorkerSee the NOTES section below for more information.
19*5e7646d2SAndroid Build Coastguard Worker<h3><a name="DIRECTIVES">Directives</a></h3>
20*5e7646d2SAndroid Build Coastguard WorkerThe following directives are understood by the client. Consult the online help for detailed descriptions:
21*5e7646d2SAndroid Build Coastguard Worker<dl class="man">
22*5e7646d2SAndroid Build Coastguard Worker<dt><a name="AllowAnyRoot"></a><b>AllowAnyRoot Yes</b>
23*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>AllowAnyRoot No</b>
24*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies whether to allow TLS with certificates that have not been signed by a trusted Certificate Authority.
25*5e7646d2SAndroid Build Coastguard WorkerThe default is "Yes".
26*5e7646d2SAndroid Build Coastguard Worker<dt><a name="AllowExpiredCerts"></a><b>AllowExpiredCerts Yes</b>
27*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>AllowExpiredCerts No</b>
28*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies whether to allow TLS with expired certificates.
29*5e7646d2SAndroid Build Coastguard WorkerThe default is "No".
30*5e7646d2SAndroid Build Coastguard Worker<dt><a name="DigestOptions"></a><b>DigestOptions DenyMD5</b>
31*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>DigestOptions None</b>
32*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies HTTP Digest authentication options.
33*5e7646d2SAndroid Build Coastguard Worker<b>DenyMD5</b> disables support for the original MD5 hash algorithm.
34*5e7646d2SAndroid Build Coastguard Worker<dt><a name="Encryption"></a><b>Encryption IfRequested</b>
35*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>Encryption Never</b>
36*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>Encryption Required</b>
37*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the level of encryption that should be used.
38*5e7646d2SAndroid Build Coastguard Worker<dt><a name="GSSServiceName"></a><b>GSSServiceName </b><i>name</i>
39*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp".
40*5e7646d2SAndroid Build Coastguard WorkerCUPS adds the remote hostname ("[email protected]") for you. The default name is "http".
41*5e7646d2SAndroid Build Coastguard Worker<dt><a name="ServerName"></a><b>ServerName </b><i>hostname-or-ip-address</i>[<i>:port</i>]
42*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>ServerName </b><i>/domain/socket</i>
43*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the address and optionally the port to use when connecting to the server.
44*5e7646d2SAndroid Build Coastguard Worker<b>Note: This directive is not supported on macOS 10.7 or later.</b>
45*5e7646d2SAndroid Build Coastguard Worker<dt><b>ServerName </b><i>hostname-or-ip-address</i>[<i>:port</i>]<b>/version=1.1</b>
46*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the address and optionally the port to use when connecting to a server running CUPS 1.3.12 and earlier.
47*5e7646d2SAndroid Build Coastguard Worker<dt><a name="SSLOptions"></a><b>SSLOptions </b>[<i>AllowDH</i>] [<i>AllowRC4</i>] [<i>AllowSSL3</i>] [<i>DenyCBC</i>] [<i>DenyTLS1.0</i>] [<i>MaxTLS1.0</i>] [<i>MaxTLS1.1</i>] [<i>MaxTLS1.2</i>] [<i>MaxTLS1.3</i>] [<i>MinTLS1.0</i>] [<i>MinTLS1.1</i>] [<i>MinTLS1.2</i>] [<i>MinTLS1.3</i>]
48*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>SSLOptions None</b>
49*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Sets encryption options (only in /etc/cups/client.conf).
50*5e7646d2SAndroid Build Coastguard WorkerBy default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
51*5e7646d2SAndroid Build Coastguard WorkerSecurity is reduced when <i>Allow</i> options are used.
52*5e7646d2SAndroid Build Coastguard WorkerSecurity is enhanced when <i>Deny</i> options are used.
53*5e7646d2SAndroid Build Coastguard WorkerThe <i>AllowDH</i> option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
54*5e7646d2SAndroid Build Coastguard WorkerThe <i>AllowRC4</i> option enables the 128-bit RC4 cipher suites, which are required for some older clients.
55*5e7646d2SAndroid Build Coastguard WorkerThe <i>AllowSSL3</i> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
56*5e7646d2SAndroid Build Coastguard WorkerThe <i>DenyCBC</i> option disables all CBC cipher suites.
57*5e7646d2SAndroid Build Coastguard WorkerThe <i>DenyTLS1.0</i> option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
58*5e7646d2SAndroid Build Coastguard WorkerThe <i>MinTLS</i> options set the minimum TLS version to support.
59*5e7646d2SAndroid Build Coastguard WorkerThe <i>MaxTLS</i> options set the maximum TLS version to support.
60*5e7646d2SAndroid Build Coastguard WorkerNot all operating systems support TLS 1.3 at this time.
61*5e7646d2SAndroid Build Coastguard Worker<dt><a name="TrustOnFirstUse"></a><b>TrustOnFirstUse Yes</b>
62*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>TrustOnFirstUse No</b>
63*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies whether to trust new TLS certificates by default.
64*5e7646d2SAndroid Build Coastguard WorkerThe default is "Yes".
65*5e7646d2SAndroid Build Coastguard Worker<dt><a name="User"></a><b>User </b><i>name</i>
66*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the default user name to use for requests.
67*5e7646d2SAndroid Build Coastguard Worker<dt><a name="UserAgentTokens"></a><b>UserAgentTokens None</b>
68*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens ProductOnly</b>
69*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Major</b>
70*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minor</b>
71*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minimal</b>
72*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens OS</b>
73*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Full</b>
74*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies what information is included in the User-Agent header of HTTP requests.
75*5e7646d2SAndroid Build Coastguard Worker"None" disables the User-Agent header.
76*5e7646d2SAndroid Build Coastguard Worker"ProductOnly" reports "CUPS".
77*5e7646d2SAndroid Build Coastguard Worker"Major" reports "CUPS/major IPP/2".
78*5e7646d2SAndroid Build Coastguard Worker"Minor" reports "CUPS/major.minor IPP/2.1".
79*5e7646d2SAndroid Build Coastguard Worker"Minimal" reports "CUPS/major.minor.patch IPP/2.1".
80*5e7646d2SAndroid Build Coastguard Worker"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1".
81*5e7646d2SAndroid Build Coastguard Worker"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1".
82*5e7646d2SAndroid Build Coastguard WorkerThe default is "Minimal".
83*5e7646d2SAndroid Build Coastguard Worker<dt><a name="ValidateCerts"></a><b>ValidateCerts Yes</b>
84*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>ValidateCerts No</b>
85*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies whether to only allow TLS with certificates whose common name matches the hostname.
86*5e7646d2SAndroid Build Coastguard WorkerThe default is "No".
87*5e7646d2SAndroid Build Coastguard Worker</dl>
88*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="NOTES">Notes</a></h2>
89*5e7646d2SAndroid Build Coastguard WorkerThe <b>client.conf</b> file is deprecated on macOS and will no longer be supported in a future version of CUPS.
90*5e7646d2SAndroid Build Coastguard WorkerConfiguration settings can instead be viewed or changed using the
91*5e7646d2SAndroid Build Coastguard Worker<b>defaults</b>(1)
92*5e7646d2SAndroid Build Coastguard Workercommand:
93*5e7646d2SAndroid Build Coastguard Worker<pre class="man">
94*5e7646d2SAndroid Build Coastguard Workerdefaults write /Library/Preferences/org.cups.PrintingPrefs.plist Encryption Required
95*5e7646d2SAndroid Build Coastguard Workerdefaults write /Library/Preferences/org.cups.PrintingPrefs.plist TrustOnFirstUse -bool NO
96*5e7646d2SAndroid Build Coastguard Worker
97*5e7646d2SAndroid Build Coastguard Workerdefaults read /Library/Preferences/org.cups.PrintingPrefs.plist Encryption
98*5e7646d2SAndroid Build Coastguard Worker</pre>
99*5e7646d2SAndroid Build Coastguard WorkerOn Linux and other systems using GNU TLS, the <i>/etc/cups/ssl/site.crl</i> file, if present, provides a list of revoked X.509 certificates and is used when validating certificates.
100*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
101*5e7646d2SAndroid Build Coastguard Worker<b>cups</b>(1),
102*5e7646d2SAndroid Build Coastguard Worker<b>default</b>(1),
103*5e7646d2SAndroid Build Coastguard WorkerCUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
104*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
105*5e7646d2SAndroid Build Coastguard WorkerCopyright &copy; 2007-2019 by Apple Inc.
106*5e7646d2SAndroid Build Coastguard Worker
107*5e7646d2SAndroid Build Coastguard Worker</body>
108*5e7646d2SAndroid Build Coastguard Worker</html>
109