fix old typo (s/SYSVINITSTOPT/SYSVINITSTOP/)
[openssh.git] / README.platform
blob4edf9d1f59374dcb4dc36fd167d66ce8ae575e7a
1 This file contains notes about OpenSSH on specific platforms.
3 AIX
5 Beginning with OpenSSH 3.8p1, sshd will honour an account's password
6 expiry settings, where prior to that it did not.  Because of this,
7 it's possible for sites that have used OpenSSH's sshd exclusively to
8 have accounts which have passwords expired longer than the inactive time
9 (ie the "Weeks between password EXPIRATION and LOCKOUT" setting in SMIT
10 or the maxexpired chuser attribute).
12 Accounts in this state must have their passwords reset manually by the
13 administrator.  As a precaution, it is recommended that the administrative
14 passwords be reset before upgrading from OpenSSH <3.8.
16 As of OpenSSH 4.0p1, configure will attempt to detect if your version
17 and maintenance level of AIX has a working getaddrinfo, and will use it
18 if found.  This will enable IPv6 support.  If for some reason configure
19 gets it wrong, or if you want to build binaries to work on earlier MLs
20 than the build host then you can add "-DBROKEN_GETADDRINFO" to CFLAGS
21 to force the previous IPv4-only behaviour.
23 IPv6 known to work: 5.1ML7 5.2ML2 5.2ML5
24 IPv6 known broken: 4.3.3ML11 5.1ML4
26 If you wish to use dynamic libraries that aren't in the normal system
27 locations (eg IBM's OpenSSL and zlib packages) then you will need to
28 define the environment variable blibpath before running configure, eg
30 blibpath=/lib:/usr/lib:/opt/freeware/lib ./configure \
31   --with-ssl-dir=/opt/freeware --with-zlib=/opt/freeware
33 If sshd is built with the WITH_AIXAUTHENTICATE option (which is enabled
34 by default) then sshd checks that users are permitted via the
35 loginrestrictions() function, in particular that the user has the
36 "rlogin" attribute set.  This check is not done for the root account,
37 instead the PermitRootLogin setting in sshd_config is used.
39 If you are using the IBM compiler you probably want to use CC=xlc rather
40 than the default of cc.
43 Cygwin
44 ------
45 To build on Cygwin, OpenSSH requires the following packages:
46 gcc, gcc-mingw-core, mingw-runtime, binutils, make, openssl,
47 openssl-devel, zlib, minres, minires-devel.
50 Darwin and MacOS X
51 ------------------
52 Darwin does not provide a tun(4) driver required for OpenSSH-based
53 virtual private networks. The BSD manpage still exists, but the driver
54 has been removed in recent releases of Darwin and MacOS X.
56 Tunnel support is known to work with Darwin 8 and MacOS X 10.4 in
57 Point-to-Point (Layer 3) and Ethernet (Layer 2) mode using a third
58 party driver. More information is available at:
59         https://tuntaposx.sourceforge.net
61 Recent Darwin/MacOS X versions are likely unsupported.
63 Linux
64 -----
66 Some Linux distributions (including Red Hat/Fedora/CentOS) include
67 headers and library links in the -devel RPMs rather than the main
68 binary RPMs. If you get an error about headers, or complaining about a
69 missing prerequisite then you may need to install the equivalent
70 development packages.  On Redhat based distros these may be openssl-devel,
71 zlib-devel and pam-devel, on Debian based distros these may be
72 libssl-dev, libz-dev and libpam-dev.
75 Solaris
76 -------
77 If you enable BSM auditing on Solaris, you need to update audit_event(4)
78 for praudit(1m) to give sensible output.  The following line needs to be
79 added to /etc/security/audit_event:
81         32800:AUE_openssh:OpenSSH login:lo
83 The BSM audit event range available for third party TCB applications is
84 32768 - 65535.  Event number 32800 has been chosen for AUE_openssh.
85 There is no official registry of 3rd party event numbers, so if this
86 number is already in use on your system, you may change it at build time
87 by configure'ing --with-cflags=-DAUE_openssh=32801 then rebuilding.
90 Platforms using PAM
91 -------------------
92 As of OpenSSH 4.3p1, sshd will no longer check /etc/nologin itself when
93 PAM is enabled.  To maintain existing behaviour, pam_nologin should be
94 added to sshd's session stack which will prevent users from starting shell
95 sessions.  Alternatively, pam_nologin can be added to either the auth or
96 account stacks which will prevent authentication entirely, but will still
97 return the output from pam_nologin to the client.