<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
<link rel="stylesheet" type="text/css" href="../cups-printable.css">
<title>client.conf(5)</title>
</head>
<body>
<h1 class="title">client.conf(5)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
client.conf - client configuration file for cups (deprecated on macos)
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The <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.
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
<p><b>Note:</b> Starting with macOS 10.7, this file is only used by command-line and X11 applications plus the IPP backend.
The <b>ServerName</b> directive is not supported on macOS at all.
Starting with macOS 10.12, all applications can access these settings in the <i>/Library/Preferences/org.cups.PrintingPrefs.plist</i> file instead.
See the NOTES section below for more information.
<h3><a name="DIRECTIVES">Directives</a></h3>
The following directives are understood by the client. Consult the online help for detailed descriptions:
<dl class="man">
<dt><a name="AllowAnyRoot"></a><b>AllowAnyRoot Yes</b>
<dd style="margin-left: 5.0em"><dt><b>AllowAnyRoot No</b>
<dd style="margin-left: 5.0em">Specifies whether to allow TLS with certificates that have not been signed by a trusted Certificate Authority.
The default is "Yes".
<dt><a name="AllowExpiredCerts"></a><b>AllowExpiredCerts Yes</b>
<dd style="margin-left: 5.0em"><dt><b>AllowExpiredCerts No</b>
<dd style="margin-left: 5.0em">Specifies whether to allow TLS with expired certificates.
The default is "No".
<dt><a name="DigestOptions"></a><b>DigestOptions DenyMD5</b>
<dd style="margin-left: 5.0em"><dt><b>DigestOptions None</b>
<dd style="margin-left: 5.0em">Specifies HTTP Digest authentication options.
<b>DenyMD5</b> disables support for the original MD5 hash algorithm.
<dt><a name="Encryption"></a><b>Encryption IfRequested</b>
<dd style="margin-left: 5.0em"><dt><b>Encryption Never</b>
<dd style="margin-left: 5.0em"><dt><b>Encryption Required</b>
<dd style="margin-left: 5.0em">Specifies the level of encryption that should be used.
<dt><a name="GSSServiceName"></a><b>GSSServiceName </b><i>name</i>
<dd style="margin-left: 5.0em">Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp".
CUPS adds the remote hostname ("name@server.example.com") for you. The default name is "http".
<dt><a name="ServerName"></a><b>ServerName </b><i>hostname-or-ip-address</i>[<i>:port</i>]
<dd style="margin-left: 5.0em"><dt><b>ServerName </b><i>/domain/socket</i>
<dd style="margin-left: 5.0em">Specifies the address and optionally the port to use when connecting to the server.
<b>Note: This directive is not supported on macOS 10.7 or later.</b>
<dt><b>ServerName </b><i>hostname-or-ip-address</i>[<i>:port</i>]<b>/version=1.1</b>
<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.
<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>]
<dd style="margin-left: 5.0em"><dt><b>SSLOptions None</b>
<dd style="margin-left: 5.0em">Sets encryption options (only in /etc/cups/client.conf).
By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
Security is reduced when <i>Allow</i> options are used.
Security is enhanced when <i>Deny</i> options are used.
The <i>AllowDH</i> option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
The <i>AllowRC4</i> option enables the 128-bit RC4 cipher suites, which are required for some older clients.
The <i>AllowSSL3</i> option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
The <i>DenyCBC</i> option disables all CBC cipher suites.
The <i>DenyTLS1.0</i> option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
The <i>MinTLS</i> options set the minimum TLS version to support.
The <i>MaxTLS</i> options set the maximum TLS version to support.
Not all operating systems support TLS 1.3 at this time.
<dt><a name="TrustOnFirstUse"></a><b>TrustOnFirstUse Yes</b>
<dd style="margin-left: 5.0em"><dt><b>TrustOnFirstUse No</b>
<dd style="margin-left: 5.0em">Specifies whether to trust new TLS certificates by default.
The default is "Yes".
<dt><a name="User"></a><b>User </b><i>name</i>
<dd style="margin-left: 5.0em">Specifies the default user name to use for requests.
<dt><a name="UserAgentTokens"></a><b>UserAgentTokens None</b>
<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens ProductOnly</b>
<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Major</b>
<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minor</b>
<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Minimal</b>
<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens OS</b>
<dd style="margin-left: 5.0em"><dt><b>UserAgentTokens Full</b>
<dd style="margin-left: 5.0em">Specifies what information is included in the User-Agent header of HTTP requests.
"None" disables the User-Agent header.
"ProductOnly" reports "CUPS".
"Major" reports "CUPS/major IPP/2".
"Minor" reports "CUPS/major.minor IPP/2.1".
"Minimal" reports "CUPS/major.minor.patch IPP/2.1".
"OS" reports "CUPS/major.minor.path (osname osversion) IPP/2.1".
"Full" reports "CUPS/major.minor.path (osname osversion; architecture) IPP/2.1".
The default is "Minimal".
<dt><a name="ValidateCerts"></a><b>ValidateCerts Yes</b>
<dd style="margin-left: 5.0em"><dt><b>ValidateCerts No</b>
<dd style="margin-left: 5.0em">Specifies whether to only allow TLS with certificates whose common name matches the hostname.
The default is "No".
</dl>
<h2 class="title"><a name="NOTES">Notes</a></h2>
The <b>client.conf</b> file is deprecated on macOS and will no longer be supported in a future version of CUPS.
Configuration settings can instead be viewed or changed using the
<b>defaults</b>(1)
command:
<pre class="man">
defaults write /Library/Preferences/org.cups.PrintingPrefs.plist Encryption Required
defaults write /Library/Preferences/org.cups.PrintingPrefs.plist TrustOnFirstUse -bool NO
defaults read /Library/Preferences/org.cups.PrintingPrefs.plist Encryption
</pre>
On 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.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<b>cups</b>(1),
<b>default</b>(1),
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright © 2007-2019 by Apple Inc.
</body>
</html>
| Name | Type | Size | Permission | Actions |
|---|---|---|---|---|
| accounting.html | File | 2.63 KB | 0644 |
|
| admin.html | File | 11.66 KB | 0644 |
|
| api-admin.html | File | 19.99 KB | 0644 |
|
| api-filter.html | File | 61.66 KB | 0644 |
|
| api-ppd.html | File | 92.21 KB | 0644 |
|
| api-raster.html | File | 59.02 KB | 0644 |
|
| cgi.html | File | 2.58 KB | 0644 |
|
| cupspm.html | File | 370.35 KB | 0644 |
|
| encryption.html | File | 4.21 KB | 0644 |
|
| firewalls.html | File | 3.94 KB | 0644 |
|
| glossary.html | File | 2.66 KB | 0644 |
|
| kerberos.html | File | 4.21 KB | 0644 |
|
| license.html | File | 11.78 KB | 0644 |
|
| man-backend.html | File | 9.35 KB | 0644 |
|
| man-cancel.html | File | 2.56 KB | 0644 |
|
| man-classes.conf.html | File | 1.15 KB | 0644 |
|
| man-client.conf.html | File | 6.91 KB | 0644 |
|
| man-cups-config.html | File | 3.3 KB | 0644 |
|
| man-cups-files.conf.html | File | 12.26 KB | 0644 |
|
| man-cups-lpd.html | File | 4.75 KB | 0644 |
|
| man-cups-snmp.html | File | 2.72 KB | 0644 |
|
| man-cups.html | File | 7.43 KB | 0644 |
|
| man-cupsaccept.html | File | 2.48 KB | 0644 |
|
| man-cupsd-helper.html | File | 2.59 KB | 0644 |
|
| man-cupsd-logs.html | File | 9.55 KB | 0644 |
|
| man-cupsd.conf.html | File | 37.78 KB | 0644 |
|
| man-cupsd.html | File | 3.22 KB | 0644 |
|
| man-cupsenable.html | File | 2.97 KB | 0644 |
|
| man-cupstestppd.html | File | 4.83 KB | 0644 |
|
| man-filter.html | File | 11.36 KB | 0644 |
|
| man-ippevepcl.html | File | 1.88 KB | 0644 |
|
| man-ippeveprinter.html | File | 9.88 KB | 0644 |
|
| man-ippfind.html | File | 9.72 KB | 0644 |
|
| man-ipptool.html | File | 7.53 KB | 0644 |
|
| man-ipptoolfile.html | File | 27.3 KB | 0644 |
|
| man-lp.html | File | 7.32 KB | 0644 |
|
| man-lpadmin.html | File | 10.04 KB | 0644 |
|
| man-lpc.html | File | 2.11 KB | 0644 |
|
| man-lpinfo.html | File | 3.66 KB | 0644 |
|
| man-lpmove.html | File | 1.91 KB | 0644 |
|
| man-lpoptions.html | File | 3.88 KB | 0644 |
|
| man-lpq.html | File | 1.97 KB | 0644 |
|
| man-lpr.html | File | 5.93 KB | 0644 |
|
| man-lprm.html | File | 2.08 KB | 0644 |
|
| man-lpstat.html | File | 4.55 KB | 0644 |
|
| man-mime.convs.html | File | 2.59 KB | 0644 |
|
| man-mime.types.html | File | 5.47 KB | 0644 |
|
| man-notifier.html | File | 1.35 KB | 0644 |
|
| man-ppdc.html | File | 3.5 KB | 0644 |
|
| man-ppdhtml.html | File | 1.83 KB | 0644 |
|
| man-ppdi.html | File | 1.99 KB | 0644 |
|
| man-ppdmerge.html | File | 1.75 KB | 0644 |
|
| man-ppdpo.html | File | 2.09 KB | 0644 |
|
| man-printers.conf.html | File | 1.18 KB | 0644 |
|
| man-subscriptions.conf.html | File | 1.22 KB | 0644 |
|
| network.html | File | 18.56 KB | 0644 |
|
| options.html | File | 16.42 KB | 0644 |
|
| overview.html | File | 3.4 KB | 0644 |
|
| policies.html | File | 21.25 KB | 0644 |
|
| postscript-driver.html | File | 23.26 KB | 0644 |
|
| ppd-compiler.html | File | 45.13 KB | 0644 |
|
| raster-driver.html | File | 20.32 KB | 0644 |
|
| ref-ppdcfile.html | File | 69.29 KB | 0644 |
|
| security.html | File | 4.44 KB | 0644 |
|
| sharing.html | File | 4.45 KB | 0644 |
|
| spec-banner.html | File | 4.05 KB | 0644 |
|
| spec-command.html | File | 6.08 KB | 0644 |
|
| spec-design.html | File | 13.05 KB | 0644 |
|
| spec-ipp.html | File | 65.4 KB | 0644 |
|
| spec-ppd.html | File | 90.33 KB | 0644 |
|
| spec-raster.html | File | 23.34 KB | 0644 |
|
| spec-stp.html | File | 3.79 KB | 0644 |
|
| translation.html | File | 24.29 KB | 0644 |
|