3 FreeBSD maintainer's guide to OpenSSH-portable
4 ==============================================
6 00) Make sure your mail spool has plenty of free space. It'll fill up
7 pretty fast once you're done with this checklist.
9 01) Download the latest OpenSSH-portable tarball and signature from
10 OpenBSD (ftp://ftp.openbsd.org/pub/OpenBSD/OpenSSH/portable/).
12 02) Verify the signature:
14 $ gpg --verify openssh-X.YpZ.tar.gz.asc
16 03) Unpack the tarball in a suitable directory:
18 $ tar xf openssh-X.YpZ.tar.gz
20 04) Copy to the vendor directory:
22 $ svn co svn+ssh://svn.freebsd.org/base/vendor-crypto/openssh/dist
23 $ rsync --archive --delete openssh-X.YpZ/ dist/
25 05) Take care of added / deleted files:
27 $ svn rm $(svn stat dist | awk '$1 == "!" { print $2 }')
28 $ svn add --no-auto-props $(svn stat dist | awk '$1 == "?" { print $2 }')
32 $ svn commit -m "Vendor import of OpenSSH X.YpZ." dist
36 $ svn copy -m "Tag OpenSSH X.YpZ." \
37 svn+ssh://svn.freebsd.org/base/vendor-crypto/openssh/dist \
38 svn+ssh://svn.freebsd.org/base/vendor-crypto/openssh/X.YpZ
40 08) Check out head and run the pre-merge script:
42 $ svn co svn+ssh://svn.freebsd.org/base/head
43 $ cd head/crypto/openssh
44 $ sh freebsd-pre-merge.sh
46 09) Merge from the vendor branch:
48 $ svn merge -cNNNNNN \^/vendor-crypto/openssh/dist .
50 0A) Resolve conflicts. Remember to bump the version addendum in
51 version.h, and update the default value in ssh{,d}_config and
54 0B) Diff against the vendor branch:
56 $ svn diff \^/vendor-crypto/openssh/dist .
58 Files that have modifications relative to the vendor code, and
59 only those files, must have the svn:keywords property set to
60 FreeBSD=%H and be listed in the 'keywords' file created by the
63 0C) Run the post-merge script:
65 $ sh freebsd-post-merge.sh
67 0D) Run the configure script:
69 $ sh freebsd-configure.sh
71 0E) Check config.h very carefully.
73 0F) If source files have been added or removed, update the appropriate
74 makefiles to reflect changes in the vendor's Makefile.in.
78 $ cd ../../secure/lib/libssh && make obj && make depend && make
80 11) Follow the instructions in ssh_namespace.h to get a list of new
81 symbols, and them to ssh_namespace.h. Keep it sorted!
83 12) Build and install world, reboot, test. Pay particular attention
84 to pam_ssh(8), which gropes inside libssh and will break if
85 something significant changes or if ssh_namespace.h is out of
88 13) Commit, and hunker down for the inevitable storm of complaints.
92 An overview of FreeBSD changes to OpenSSH-portable
93 ==================================================
95 XXX This section is out of date
99 The SSH protocol allows for a human-readable version string of up
100 to 40 characters to be appended to the protocol version string.
101 FreeBSD takes advantage of this to include a date indicating the
102 "patch level", so people can easily determine whether their system
103 is vulnerable when an OpenSSH advisory goes out. Some people,
104 however, dislike advertising their patch level in the protocol
105 handshake, so we've added a VersionAddendum configuration variable
106 to allow them to change or disable it.
108 1) Modified server-side defaults
110 We've modified some configuration defaults in sshd:
112 - PasswordAuthentication defaults to "no".
114 - LoginGraceTime defaults to 120 seconds instead of 600.
116 - PermitRootLogin defaults to "no".
118 - X11Forwarding defaults to "yes" (it's a threat to the client,
121 2) Modified client-side defaults
123 We've modified some configuration defaults in ssh:
125 - CheckHostIP defaults to "no".
127 3) Canonic host names
129 We've added code to ssh.c to canonicize the target host name after
130 reading options but before trying to connect. This eliminates the
131 usual problem with duplicate known_hosts entries.
133 4) setusercontext() environment
135 Our setusercontext(3) can set environment variables, which we must
136 take care to transfer to the child's environment.
140 This port was brought to you by (in no particular order) DARPA, NAI
141 Labs, ThinkSec, Nescafé, the Aberlour Glenlivet Distillery Co.,
142 Suzanne Vega, and a Sanford's #69 Deluxe Marker.