man/client.conf.man.in

   1 .\"
   2 .\" client.conf man page for CUPS.
   3 .\"
   4 .\" Copyright 2007-2017 by Apple Inc.
   5 .\" Copyright 2006 by Easy Software Products.
   6 .\"
   7 .\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
   8 .\"
   9 .TH client.conf 5 "CUPS" "3 November 2017" "Apple Inc."
  10 .SH NAME
  11 client.conf \- client configuration file for cups
  12 .SH DESCRIPTION
  13 The \fBclient.conf\fR file configures the CUPS client and is normally located in the \fI/etc/cups\fR and/or \fI~/.cups\fR directories.
  14 Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
  15 .LP
  16 \fBNote:\fR Starting with macOS 10.7, this file is only used by command-line and X11 applications plus the IPP backend.
  17 The \fBServerName\fR directive is not supported on macOS at all.
  18 Starting with macOS 10.12, all applications can access these settings in the \fI/Library/Preferences/org.cups.PrintingPrefs.plist\fR file instead.
  19 See the NOTES section below for more information.
  20 .SS DIRECTIVES
  21 The following directives are understood by the client. Consult the online help for detailed descriptions:
  22 .TP 5
  23 \fBAllowAnyRoot Yes\fR
  24 .TP 5
  25 \fBAllowAnyRoot No\fR
  26 Specifies whether to allow TLS with certificates that have not been signed by a trusted Certificate Authority.
  27 The default is "Yes".
  28 .TP 5
  29 \fBAllowExpiredCerts Yes\fR
  30 .TP 5
  31 \fBAllowExpiredCerts No\fR
  32 Specifies whether to allow TLS with expired certificates.
  33 The default is "No".
  34 .TP 5
  35 \fBEncryption IfRequested\fR
  36 .TP 5
  37 \fBEncryption Never\fR
  38 .TP 5
  39 \fBEncryption Required\fR
  40 Specifies the level of encryption that should be used.
  41 .TP 5
  42 \fBGSSServiceName \fIname\fR
  43 Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp".
  44 CUPS adds the remote hostname ("name@server.example.com") for you. The default name is "http".
  45 .TP 5
  46 \fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR]
  47 .TP 5
  48 \fBServerName \fI/domain/socket\fR
  49 Specifies the address and optionally the port to use when connecting to the server.
  50 \fBNote: This directive is not supported on macOS 10.7 or later.\fR
  51 .TP 5
  52 \fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR]\fB/version=1.1\fR
  53 Specifies the address and optionally the port to use when connecting to a server running CUPS 1.3.12 and earlier.
  54 .TP 5
  55 \fBSSLOptions \fR[\fIAllowDH\fR] [\fIAllowRC4\fR] [\fIAllowSSL3\fR] [\fIDenyCBC\fR] [\fIDenyTLS1.0\fR] [\fIMaxTLS1.0\fR] [\fIMaxTLS1.1\fR] [\fIMaxTLS1.2\fR] [\fIMaxTLS1.3\fR] [\fIMinTLS1.0\fR] [\fIMinTLS1.1\fR] [\fIMinTLS1.2\fR] [\fIMinTLS1.3\fR]
  56 .TP 5
  57 \fBSSLOptions None\fR
  58 Sets encryption options (only in /etc/cups/client.conf).
  59 By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites.
  60 Security is reduced when \fIAllow\fR options are used.
  61 Security is enhanced when \fIDeny\fR options are used.
  62 The \fIAllowDH\fR option enables cipher suites using plain Diffie-Hellman key negotiation (not supported on systems using GNU TLS).
  63 The \fIAllowRC4\fR option enables the 128-bit RC4 cipher suites, which are required for some older clients.
  64 The \fIAllowSSL3\fR option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0.
  65 The \fIDenyCBC\fR option disables all CBC cipher suites.
  66 The \fIDenyTLS1.0\fR option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1.
  67 The \fMinTLS\fR options set the minimum TLS version to support.
  68 The \fMaxTLS\fR options set the maximum TLS version to support.
  69 Not all operating systems support TLS 1.3 at this time.
  70 .TP 5
  71 \fBTrustOnFirstUse Yes\fR
  72 .TP 5
  73 \fBTrustOnFirstUse No\fR
  74 Specifies whether to trust new TLS certificates by default.
  75 The default is "Yes".
  76 .TP 5
  77 \fBUser \fIname\fR
  78 Specifies the default user name to use for requests.
  79 .TP 5
  80 \fBValidateCerts Yes\fR
  81 .TP 5
  82 \fBValidateCerts No\fR
  83 Specifies whether to only allow TLS with certificates whose common name matches the hostname.
  84 The default is "No".
  85 .SH NOTES
  86 The \fBclient.conf\fR file is deprecated on macOS and will no longer be supported in a future version of CUPS.
  87 Configuration settings can instead be viewed or changed using the
  88 .BR defaults (1)
  89 command:
  90 .nf
  91 defaults write /Library/Preferences/org.cups.PrintingPrefs.plist Encryption Required
  92 defaults write /Library/Preferences/org.cups.PrintingPrefs.plist TrustOnFirstUse -bool NO
  93
  94 defaults read /Library/Preferences/org.cups.PrintingPrefs.plist Encryption
  95 .fi
  96 On Linux and other systems using GNU TLS, the \fI/etc/cups/ssl/site.crl\fR file, if present, provides a list of revoked X.509 certificates and is used when validating certificates.
  97 .SH SEE ALSO
  98 .BR cups (1),
  99 .BR default (1),
 100 CUPS Online Help (http://localhost:631/help)
 101 .SH COPYRIGHT
 102 Copyright \[co] 2007-2017 by Apple Inc.