crypto/openssh/FREEBSD-upgrade

   1
   2             FreeBSD maintainer's guide to OpenSSH-portable
   3             ==============================================
   4
   5 00) Make sure your mail spool has plenty of free space.  It'll fill up
   6     pretty fast once you're done with this checklist.
   7
   8 01) Download the latest OpenSSH-portable tarball and signature from
   9     OpenBSD (ftp://ftp.openbsd.org/pub/OpenBSD/OpenSSH/portable/).
  10
  11 02) Verify the signature:
  12
  13     $ gpg --verify openssh-X.YpZ.tar.gz.asc
  14
  15 03) Unpack the tarball in a suitable directory:
  16
  17     $ tar xf openssh-X.YpZ.tar.gz
  18
  19 04) Copy to the vendor directory:
  20
  21     $ svn co svn+ssh://svn.freebsd.org/base/vendor-crypto/openssh/dist
  22     $ rsync --archive --delete openssh-X.YpZ/ dist/
  23
  24 05) Take care of added / deleted files:
  25
  26     $ svn rm $(svn stat dist | awk '$1 == "!" { print $2 }')
  27     $ svn add --no-auto-props $(svn stat dist | awk '$1 == "?" { print $2 }')
  28
  29 06) Commit:
  30
  31     $ svn commit -m "Vendor import of OpenSSH X.YpZ." dist
  32
  33 07) Tag:
  34
  35     $ svn copy -m "Tag OpenSSH X.YpZ." \
  36         svn+ssh://svn.freebsd.org/base/vendor-crypto/openssh/dist \
  37         svn+ssh://svn.freebsd.org/base/vendor-crypto/openssh/X.YpZ
  38
  39 08) Check out head and run the pre-merge script, which strips our RCS
  40     tags from files that have them:
  41
  42     $ svn co svn+ssh://svn.freebsd.org/base/head
  43     $ cd head/crypto/openssh
  44     $ sh freebsd-pre-merge.sh
  45
  46 09) Merge from the vendor branch:
  47
  48     $ svn merge -cNNNNNN \^/vendor-crypto/openssh/dist .
  49
  50 0A) Resolve conflicts.  Remember to bump the version addendum in
  51     version.h, and update the default value in ssh{,d}_config and
  52     ssh{,d}_config.5.
  53
  54 0B) Diff against the vendor branch:
  55
  56     $ svn diff --no-diff-deleted --no-diff-added \
  57         --ignore-properties \^/vendor-crypto/openssh/X.YpZ .
  58
  59     Files that have modifications relative to the vendor code, and
  60     only those files, must have the svn:keywords property set to
  61     FreeBSD=%H and be listed in the 'keywords' file created by the
  62     pre-merge script.
  63
  64 0C) Run the post-merge script, which re-adds RCS tags to files that
  65     need them:
  66
  67     $ sh freebsd-post-merge.sh
  68
  69 0D) Run the configure script:
  70
  71     $ sh freebsd-configure.sh
  72
  73 0E) Review changes to config.h very carefully.
  74
  75 0F) If source files have been added or removed, update the appropriate
  76     makefiles to reflect changes in the vendor's Makefile.in.
  77
  78 10) Build libssh:
  79
  80     $ cd ../../secure/lib/libssh && make obj && make depend && make
  81
  82 11) Follow the instructions in ssh_namespace.h to get a list of new
  83     symbols, and them to ssh_namespace.h.  Keep it sorted!
  84
  85 12) Build and install world, reboot, test.  Pay particular attention
  86     to pam_ssh(8), which gropes inside libssh and will break if
  87     something significant changes or if ssh_namespace.h is out of
  88     whack.
  89
  90 13) Commit, and hunker down for the inevitable storm of complaints.
  91
  92 \f
  93
  94           An overview of FreeBSD changes to OpenSSH-portable
  95           ==================================================
  96
  97 0) VersionAddendum
  98
  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.  Upstream added support for
 107    VersionAddendum on the server side, but we also support it on the
 108    client side.
 109
 110 1) Modified server-side defaults
 111
 112    We've modified some configuration defaults in sshd:
 113
 114       - UsePAM defaults to "yes".
 115       - PermitRootLogin defaults to "no".
 116       - X11Forwarding defaults to "yes".
 117       - PasswordAuthentication defaults to "no".
 118       - VersionAddendum defaults to "FreeBSD-YYYYMMDD".
 119       - PrivilegeSeparation defaults to "sandbox".
 120       - UseDNS defaults to "yes".
 121
 122 2) Modified client-side defaults
 123
 124    We've modified some configuration defaults in ssh:
 125
 126       - CheckHostIP defaults to "no".
 127       - VerifyHostKeyDNS defaults to "yes" if built with LDNS.
 128       - VersionAddendum defaults to "FreeBSD-YYYYMMDD".
 129
 130 3) Canonic host names
 131
 132    We've added code to ssh.c to canonicize the target host name after
 133    reading options but before trying to connect.  This eliminates the
 134    usual problem with duplicate known_hosts entries.
 135
 136 4) setusercontext() environment
 137
 138    Our setusercontext(3) can set environment variables, which we must
 139    take care to transfer to the child's environment.
 140
 141 5) TCP wrappers
 142
 143    Support for TCP wrappers was removed in upstream 6.7p1.  We've
 144    added it back by porting the 6.6p1 code forward.
 145
 146 6) DSA keys
 147
 148    DSA keys were disabled by default in upstream 6.9p1.  We've added
 149    them back.
 150
 151 7) Agent client reference counting
 152
 153    We've added code to ssh-agent.c to implement client reference
 154    counting; the agent will automatically exit when the last client
 155    disconnects.
 156
 157 8) Class-based login restrictions
 158
 159    We've added code to auth2.c to enforce the host.allow, host.deny,
 160    times.allow and times.deny login class capabilities.
 161
 162 9) HPN
 163
 164    We no longer have the HPN patches (adaptive buffer size for
 165    increased throughput on high-BxD links), but we recognize and
 166    ignore HPN-related configuration options to avoid breaking existing
 167    configurations.
 168
 169 \f
 170
 171 This port was brought to you by (in no particular order) DARPA, NAI
 172 Labs, ThinkSec, Nescafé, the Aberlour Glenlivet Distillery Co.,
 173 Suzanne Vega, and a Sanford's #69 Deluxe Marker.
 174
 175                                         -- des@FreeBSD.org
 176
 177 $FreeBSD$