setup/setup-openssh.pl

   1 #
   2 # setup-openssh.pl:
   3 #   Adapts the installed gsi-ssh environment to the current machine,
   4 #   performing actions that originally occurred during the package's
   5 #   'make install' phase.
   6 #
   7 # Large parts adapted from 'fixpath', a tool found in openssh-3.0.2p1.
   8 #
   9 # Send comments/fixes/suggestions to:
  10 # Chase Phillips <cphillip@ncsa.uiuc.edu>
  11 #
  12
  13 $gpath = $ENV{GLOBUS_LOCATION};
  14 if (!defined($gpath))
  15 {
  16     die "GLOBUS_LOCATION needs to be set before running this script"
  17 }
  18
  19 #
  20 # i'm including this because other perl scripts in the gpt setup directories
  21 # do so
  22 #
  23
  24 @INC = (@INC, "$gpath/lib/perl");
  25
  26 require Grid::GPT::Setup;
  27
  28 my $globusdir = $gpath;
  29 my $setupdir = "$globusdir/setup/globus";
  30 my $myname = "setup-openssh.pl";
  31
  32 #
  33 # Set up path prefixes for use in the path translations
  34 #
  35
  36 $prefix = ${globusdir};
  37 $exec_prefix = "${prefix}";
  38 $bindir = "${exec_prefix}/bin";
  39 $sbindir = "${exec_prefix}/sbin";
  40 $mandir = "${prefix}/man";
  41 $mansubdir = "man";
  42 $libexecdir = "${exec_prefix}/libexec";
  43 $sysconfdir = "/etc/ssh";
  44 $piddir = "/var/run";
  45 $xauth_path = "/usr/bin/X11/xauth";
  46
  47 #
  48 # Backup-related variables
  49 #
  50
  51 $curr_time = time();
  52 $backupdir = "globus_backup_${curr_time}";
  53 $confbackupdir = "$backupdir/s1_conf";
  54 $transbackupdir = "$backupdir/s3_trans";
  55
  56 #
  57 # We need to make sure it's okay to copy our setup files (if some files are already
  58 # present).  If we do copy any files, we backup the old files so the user can (possibly)
  59 # reverse any damage.
  60 #
  61
  62 sub test_dirs
  63 {
  64     my $composite;
  65
  66     print "\nPreparatory: checking for existence of critical directories\n";
  67
  68     #
  69     # Remember to put in check for /etc
  70     #
  71
  72     #
  73     # Test for /etc/ssh
  74     #
  75
  76     $composite = $sysconfdir;
  77     if ( ! -d "$composite" )
  78     {
  79         print "Could not find directory: '${composite}'.. creating.\n";
  80         mkdir($composite, 16877);
  81         # 16877 should be 755, or drwxr-xr-x
  82     }
  83
  84     #
  85     # Test for /etc/ssh/globus_backup_<curr>
  86     #
  87
  88     $composite = "$sysconfdir/$backupdir";
  89     if ( ! -d "${composite}" )
  90     {
  91         print "Could not find directory: '${composite}'.. creating.\n";
  92         mkdir($composite, 16877);
  93     }
  94
  95     #
  96     # Test for /etc/ssh/globus_backup_<curr>/s1_conf
  97     #
  98
  99     $composite = "$sysconfdir/$confbackupdir";
 100     if ( ! -d "${composite}" )
 101     {
 102         print "Could not find directory: '${composite}'.. creating.\n";
 103         mkdir($composite, 16877);
 104     }
 105
 106     #
 107     # Test for /etc/ssh/globus_backup_<curr>/s2_trans
 108     #
 109
 110     $composite = "$sysconfdir/$transbackupdir";
 111     if ( ! -d "${composite}" )
 112     {
 113         print "Could not find directory: '${composite}'.. creating.\n";
 114         mkdir($composite, 16877);
 115     }
 116
 117     return 0;
 118 }
 119
 120 sub copy_setup_files
 121 {
 122     my $response;
 123
 124     print "\nStage 1: Copying configuration files into '${sysconfdir}'..\n";
 125
 126     $response = "y";
 127     if ( -e "${sysconfdir}/ssh_config" )
 128     {
 129         $response = query_boolean("${sysconfdir}/ssh_config already exists.  Overwrite?", "n");
 130         if ($response eq "y")
 131         {
 132             action("cp ${sysconfdir}/ssh_config ${sysconfdir}/${confbackupdir}/ssh_config");
 133         }
 134     }
 135
 136     if ($response eq "y")
 137     {
 138         action("cp ${globusdir}/setup/globus/ssh_config ${sysconfdir}/ssh_config");
 139     }
 140
 141     #
 142     # Reset response for our new query
 143     #
 144
 145     $response = "y";
 146     if ( -e "${sysconfdir}/sshd_config" )
 147     {
 148         $response = query_boolean("${sysconfdir}/sshd_config already exists.  Overwrite?", "n");
 149         if ($response eq "y")
 150         {
 151             action("cp ${sysconfdir}/sshd_config ${sysconfdir}/${confbackupdir}/sshd_config");
 152         }
 153     }
 154
 155     if ($response eq "y")
 156     {
 157         action("cp ${globusdir}/setup/globus/sshd_config ${sysconfdir}/sshd_config");
 158     }
 159
 160     #
 161     # Reset response for our new query
 162     #
 163
 164     $response = "y";
 165     if ( -e "${sysconfdir}/moduli" )
 166     {
 167         $response = query_boolean("${sysconfdir}/moduli already exists.  Overwrite?", "n");
 168         if ($response eq "y")
 169         {
 170             action("cp ${sysconfdir}/moduli ${sysconfdir}/${confbackupdir}/moduli");
 171         }
 172     }
 173
 174     if ($response eq "y")
 175     {
 176         action("cp ${globusdir}/setup/globus/moduli ${sysconfdir}/moduli");
 177     }
 178 }
 179
 180 sub runkeygen
 181 {
 182     print "\nStage 2: Generating ssh host keys..\n";
 183
 184     if ( ! -d "${sysconfdir}" )
 185     {
 186         print "Could not find ${sysconfdir} directory... creating\n";
 187         mkdir($sysconfdir, 16877);
 188         # 16877 should be 755, or drwxr-xr-x
 189     }
 190
 191     if ( -e "${sysconfdir}/ssh_host_key" )
 192     {
 193         print "${sysconfdir}/ssh_host_key already exists, skipping.\n";
 194     }
 195     else
 196     {
 197         # if $sysconfdir/ssh_host_key doesn't exist..
 198         action("$bindir/ssh-keygen -t rsa1 -f $sysconfdir/ssh_host_key -N \"\"");
 199     }
 200
 201     if ( -e "${sysconfdir}/ssh_host_dsa_key" )
 202     {
 203         print "${sysconfdir}/ssh_host_dsa_key already exists, skipping.\n";
 204     }
 205     else
 206     {
 207         # if $sysconfdir/ssh_host_dsa_key doesn't exist..
 208         action("$bindir/ssh-keygen -t dsa -f $sysconfdir/ssh_host_dsa_key -N \"\"");
 209     }
 210
 211     if ( -e "${sysconfdir}/ssh_host_rsa_key" )
 212     {
 213         print "${sysconfdir}/ssh_host_rsa_key already exists, skipping.\n";
 214     }
 215     else
 216     {
 217         # if $sysconfdir/ssh_host_rsa_key doesn't exist..
 218         action("$bindir/ssh-keygen -t rsa -f $sysconfdir/ssh_host_rsa_key -N \"\"");
 219     }
 220
 221     return 0;
 222 }
 223
 224 sub fixpaths
 225 {
 226     my $g, $h;
 227
 228     #
 229     # Set up path translations for the installation files
 230     #
 231
 232     %def = (
 233         "/etc/ssh_config" => "${sysconfdir}/ssh_config",
 234         "/etc/ssh_known_hosts" => "${sysconfdir}/ssh_known_hosts",
 235         "/etc/sshd_config" => "${sysconfdir}/sshd_config",
 236         "/usr/libexec" => "${libexecdir}",
 237         "/etc/shosts.equiv" => "${sysconfdir}/shosts.equiv",
 238         "/etc/ssh_host_key" => "${sysconfdir}/ssh_host_key",
 239         "/etc/ssh_host_dsa_key" => "${sysconfdir}/ssh_host_dsa_key",
 240         "/etc/ssh_host_rsa_key" => "${sysconfdir}/ssh_host_rsa_key",
 241         "/var/run/sshd.pid" => "${piddir}/sshd.pid",
 242         "/etc/moduli" => "${sysconfdir}/moduli",
 243         "/etc/sshrc" => "${sysconfdir}/sshrc",
 244         "/usr/X11R6/bin/xauth" => "${xauth_path}",
 245         "/usr/bin:/bin:/usr/sbin:/sbin" => "/usr/bin:/bin:/usr/sbin:/sbin:${bindir}",
 246         );
 247
 248     #
 249     # Files on which to perform path translations
 250     #
 251
 252     %files = (
 253         "${sysconfdir}/ssh_config" => 1,
 254         "${sysconfdir}/sshd_config" => 1,
 255         "${sysconfdir}/moduli" => 1,
 256         "${mandir}/${mansubdir}1/scp.1" => 0,
 257         "${mandir}/${mansubdir}1/ssh-add.1" => 0,
 258         "${mandir}/${mansubdir}1/ssh-agent.1" => 0,
 259         "${mandir}/${mansubdir}1/ssh-keygen.1" => 0,
 260         "${mandir}/${mansubdir}1/ssh-keyscan.1" => 0,
 261         "${mandir}/${mansubdir}1/ssh.1" => 0,
 262         "${mandir}/${mansubdir}8/sshd.8" => 0,
 263         "${mandir}/${mansubdir}8/sftp-server.8" => 0,
 264         "${mandir}/${mansubdir}1/sftp.1" => 0,
 265         );
 266
 267     print "\nStage 3: Translating strings in config and man files...\n";
 268
 269     for my $f (keys %files)
 270     {
 271         $f =~ /(.*\/)*(.*)$/;
 272
 273         #
 274         # we really should create a random filename and make sure that it
 275         # doesn't already exist (based off current time_t or something)
 276         #
 277
 278         $g = "$f.tmp";
 279
 280         #
 281         # get the filename for $f and place it in $h.
 282         #
 283
 284         $h = $f;
 285         $h =~ s#^.*/##;
 286
 287         #
 288         # Grab the current mode/uid/gid for use later
 289         #
 290
 291         $mode = (stat($f))[2];
 292         $uid = (stat($f))[4];
 293         $gid = (stat($f))[5];
 294
 295         #
 296         # Move $f into a .tmp file for the translation step
 297         #
 298
 299         $result = system("mv $f $g 2>&1");
 300         if ($result or $?)
 301         {
 302             die "ERROR: Unable to execute command: $!\n";
 303         }
 304
 305         #
 306         # Create a backup of this file if it's flagged
 307         #
 308
 309         if ($files{$f} == 1)
 310         {
 311             $result = system("cp $g ${sysconfdir}/${transbackupdir}/$h 2>&1");
 312
 313             if ($result or $?)
 314             {
 315                 die "ERROR: Unable to execute command: $!\n";
 316             }
 317         }
 318
 319         open(IN, "<$g") || die ("$0: input file $g missing!\n");
 320         open(OUT, ">$f") || die ("$0: unable to open output file $f!\n");
 321
 322         while (<IN>)
 323         {
 324             for $s (keys(%def))
 325             {
 326                 s#$s#$def{$s}#;
 327             } # for $s
 328             print OUT "$_";
 329         } # while <IN>
 330
 331         close(OUT);
 332         close(IN);
 333
 334         #
 335         # Remove the old .tmp file
 336         #
 337
 338         $result = system("rm $g 2>&1");
 339
 340         if ($result or $?)
 341         {
 342             die "ERROR: Unable to execute command: $!\n";
 343         }
 344
 345         #
 346         # An attempt to revert the new file back to the original file's
 347         # mode/uid/gid
 348         #
 349
 350         chmod($mode, $f);
 351         chown($uid, $gid, $f);
 352     } # for $f
 353
 354     print "complete.\n";
 355
 356     return 0;
 357 }
 358
 359 print "---------------------------------------------------------------\n";
 360 print "$myname: Configuring package 'gsi_openssh'..\n";
 361 print "\n";
 362 print "--> NOTE: Run this as root for the intended effect. <--\n";
 363
 364 test_dirs();
 365 copy_setup_files();
 366 runkeygen();
 367 fixpaths();
 368
 369 my $metadata = new Grid::GPT::Setup(package_name => "gsi_openssh_setup");
 370
 371 $metadata->finish();
 372
 373 print "\n";
 374 print "$myname: Finished configuring package 'gsi_openssh'.\n";
 375 print "\n";
 376 print "You are required to set the following variables in your environment\n";
 377 print "to ensure that the gsi_ssh package works correctly:\n";
 378 print "\n";
 379 print "\GSI_SCP_LOC=\"${bindir}/scp.real\"\n";
 380 print "\GSI_SFTP_LOC=\"${bindir}/sftp.real\"\n";
 381 print "\GSI_SSH_LOC=\"${bindir}/ssh\"\n";
 382 print "\GSI_SSHD_LOC=\"${sbindir}/sshd.real\"\n";
 383 print "\GSI_SSH_CONFIG_LOC=\"${sysconfdir}/ssh_config\"\n";
 384 print "\GSI_SSHD_CONFIG_LOC=\"${sysconfdir}/sshd_config\"\n";
 385 print "---------------------------------------------------------------\n";
 386
 387 #
 388 # Just need a minimal action() subroutine for now..
 389 #
 390
 391 sub action
 392 {
 393     my ($command) = @_;
 394
 395     printf "$command\n";
 396
 397     my $result = system("$command 2>&1");
 398
 399     if (($result or $?) and $command !~ m!patch!)
 400     {
 401         die "ERROR: Unable to execute command: $!\n";
 402     }
 403 }
 404
 405 sub query_boolean
 406 {
 407     my ($query_text, $default) = @_;
 408     my $nondefault, $foo, $bar;
 409
 410     #
 411     # Set $nondefault to the boolean opposite of $default.
 412     #
 413
 414     if ($default eq "n")
 415     {
 416         $nondefault = "y";
 417     }
 418     else
 419     {
 420         $nondefault = "n";
 421     }
 422
 423     print "${query_text} ";
 424     print "[$default] ";
 425
 426     $foo = <STDIN>;
 427     ($bar) = split //, $foo;
 428
 429     if ($bar ne $nondefault)
 430     {
 431         $bar = $default;
 432     }
 433
 434     return $bar;
 435 }
 436