├── .gitignore ├── README.md ├── sshsetup.sh └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.DS_Store* 2 | ._* 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sshsetup 2 | 3 | An interactive Linux/UNIX bash script that attempts to streamline the setup of SSH connections on new systems. It executes as a 'simple' interactive terminal at prompt-level, or as a pretty whiptail menu (if it's installed on your system. If not, it will execute the 'simple' version). 4 | 5 | Note: Whiptail should be installed by default on Debian systems. You can also install it using `sudo apt-get install whiptail`. 6 | 7 | The following options are presented to the user in both 'simple' and whiptail versions: 8 | 9 | 1. Install/Update openssh-server (Linux apt-get) 10 | 2. Configure remote host variables 11 | 3. Setup ssh keys in ~/.ssh & transfer to remote host 12 | 4. Add remote host entry to ~/.ssh/config 13 | 5. Add remote host entry to /etc/hosts 14 | 6. Auto Setup 15 | 7. Quit 16 | 17 | ## 1. Install/Upgrade openssh-server 18 | 19 | This option simply executes `sudo apt-get install openssh-server` 20 | 21 | Obviously, it won't be successful on systems which don't use apt for a package manager. 22 | 23 | ## 2. Configure Remote Host Variables 24 | 25 | This option interactively prompts the user to enter the port, ip, username, and hostname of the machine they are trying to connect with. It then stores the input into variables, which are called by other options in the script later. 26 | 27 | Options 3, 4, & 5 require option 2 be completed. 28 | 29 | ## 3. Setup SSH Keys in ~/.ssh & Transfer to Remote Host 30 | 31 | This option first checks if the directory ~/.ssh exists. If it doesn't, it will prompt the user to create it. 32 | 33 | It will then create ssh keys (private and .pub) in ~/.ssh using the hostname variable (set in option 2) as the filename. It executes `ssh-keygen -f $hostname`. The whiptail version automatically creates the keys with no passphrase to increase automation (might change). 34 | 35 | It then uses the variables set in option 2 to transfer the newly created .pub key to the remote host the user is trying to connect with. It executes `ssh-copy-id -i $hostname.pub -p $port $user@$ip`. 36 | 37 | It reminds users that passwordless login can't occur until option 4 is complete. 38 | 39 | ## 4. Add remote host entry to ~/.ssh/config 40 | 41 | This option backs up ~/.ssh/config - if it exists - then prompts the user to add an entry based on the variables set in option 2 to ~/.ssh/config. The entry is formatted as such: 42 | 43 | ``` 44 | Host $hostname 45 | Hostname $ipaddress 46 | User $username 47 | Port $port 48 | IdentityFile $HOME/.ssh/$hostname 49 | ``` 50 | 51 | This tells the ssh agent the hostname, ip, username, port, and private key location (for more secure authentication & passwordless login, which openssh is configured for by default). 52 | 53 | It reminds users that passworless login can now be done using `ssh $hostname` 54 | 55 | ## 5. Add remote host entry to /etc/hosts 56 | 57 | This option prompts the user to backup their /etc/hosts file, then add a simple entry to it using the variables set in option 2. The entry is formatted as such: 58 | 59 | `x.x.x.x $hostname` 60 | 61 | This simply allows the user to use the remote host's hostname instead of an ip address. For example: `http://meaningoflife/` instead of `http://192.168.1.42/` 62 | 63 | ## 6. Auto Setup 64 | 65 | This option simpy runs options 2 to 5 in succession on the terminal to cut down on user prompting. The script stops once at the beginning to ask the user if the remote host variables they input are correct. A couple of commands prompt the user for info (ssh key passphrases, ssh passwords, sudo passwords) along the way. 66 | 67 | When complete, the auto setup process will stop and prompt the user to return to the main menu. It's recommended to look through the auto setup process output for errors before returning to the main menu. 68 | 69 | ## 7. Quit 70 | 71 | Quits the script, unsetting all variables. 72 | -------------------------------------------------------------------------------- /sshsetup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ############################ 4 | # sshsetup v1.5 # 5 | # Written by Matthew Janik # 6 | ############################ 7 | 8 | ############################ 9 | # Environment # 10 | ############################ 11 | 12 | ## Colour text variables 13 | 14 | R=$(tput setaf 1) 15 | G=$(tput setaf 2) 16 | Y=$(tput setaf 3) 17 | B=$(tput setaf 4) 18 | P=$(tput setaf 5) 19 | C=$(tput setaf 6) 20 | D=$(tput sgr0) 21 | echo 22 | 23 | ## Border around text function 24 | 25 | border () { 26 | local str="$*" # Put all arguments into single string 27 | local len=${#str} 28 | local i 29 | for (( i = 0; i < len + 4; ++i )); do 30 | printf '=' 31 | done 32 | printf "\n| %s |\n" "$C""$str""$D" 33 | for (( i = 0; i < len + 4; ++i )); do 34 | printf '=' 35 | done 36 | echo 37 | } 38 | 39 | ## Main menu prompt function 40 | 41 | menuprompt () { 42 | ANS2=n 43 | while [ "$ANS2" != "y" ] && [ "$ANS2" != "Y" ]; 44 | do 45 | read -rp "Main Menu? [y/n]: " ANS2 46 | if [ "$ANS2" = "n" ] || [ "$ANS2" = "N" ]; 47 | then 48 | : 49 | elif [ "$ANS2" = "y" ] || [ "$ANS2" = "Y" ]; 50 | then 51 | echo 52 | echo "Returning..." 53 | echo 54 | sleep 0.7 55 | break 56 | fi 57 | done 58 | } 59 | 60 | ## Proceed prompt function 61 | 62 | proceedprompt () { 63 | ANS4=n 64 | while [ "$ANS4" != "y" ] && [ "$ANS4" != "Y" ]; 65 | do 66 | read -rp "Proceed? [y/n]: " ANS4 67 | if [ "$ANS4" = "n" ] || [ "$ANS4" = "N" ]; 68 | then 69 | : 70 | elif [ "$ANS4" = "y" ] || [ "$ANS4" = "Y" ]; 71 | then 72 | sleep 0.7 73 | break 74 | fi 75 | done 76 | } 77 | 78 | ## Remote host variables list - non whiptail 79 | 80 | remotevarlist () { 81 | if [ -z ${PORTVAR+x} ]; 82 | then 83 | echo "${C}Port${D} ${R}isn't${D} set." 84 | sleep 0.3 85 | else 86 | echo 87 | echo "${C}Port${D} ${G}is${D} set to ${G}${PORTVAR}${D}." 88 | sleep 0.3 89 | fi 90 | if [ -z ${IPVAR+x} ]; 91 | then 92 | echo "${C}IP${D} ${R}isn't${D} set." 93 | sleep 0.3 94 | else 95 | echo "${C}IP${D} ${G}is${D} set to ${G}${IPVAR}${D}." 96 | sleep 0.3 97 | fi 98 | if [ -z ${USERVAR+x} ]; 99 | then 100 | echo "${C}Username${D} ${R}isn't${D} set." 101 | sleep 0.3 102 | else 103 | echo "${C}Username${D} ${G}is${D} set to ${G}${USERVAR}${D}." 104 | sleep 0.3 105 | fi 106 | if [ -z ${HOSTVAR+x} ]; 107 | then 108 | echo "${C}Hostname${D} ${R}isn't${D} set." 109 | sleep 0.3 110 | else 111 | echo "${C}Hostname${D} ${G}is${D} set to ${G}${HOSTVAR}${D}." 112 | sleep 0.3 113 | fi 114 | 115 | } 116 | 117 | ### Option Functions - non whiptail 118 | 119 | # Option 1 120 | 121 | optionone () { 122 | echo "To install/upgrade openssh-server we need to provide our password to sudo apt-get,"\ 123 | "if we haven't already." 124 | echo 125 | sleep 0.7 126 | sudo apt-get install openssh-server 127 | echo 128 | menuprompt 129 | } 130 | 131 | # Option 2 132 | 133 | optiontwo () { 134 | PORTVAR= 135 | IPVAR= 136 | USERVAR= 137 | HOSTVAR= 138 | #Port 139 | while [[ $PORTVAR = "" ]] || [[ ! "$PORTVAR" =~ ^-?[0-9]+$ ]]; 140 | do 141 | read -rp "Enter remote host's ${C}ssh port${D}: " PORTVAR 142 | if [ "$PORTVAR" = "" ] || [[ ! "$PORTVAR" =~ ^-?[0-9]+$ ]]; 143 | then 144 | echo "${R}Please enter a number${D}." 145 | fi 146 | done 147 | #IP 148 | while [[ $IPVAR = "" ]] || [[ ! $IPVAR =~ ^-?[0-9.]+$ ]]; 149 | do 150 | read -rp "Enter remote host's ${C}IP address${D}: " IPVAR 151 | if [ "$IPVAR" = "" ] || [[ ! "$IPVAR" =~ ^-?[0-9.]+$ ]]; 152 | then 153 | echo "${R}Please enter an ip (x.x.x.x)${D}." 154 | fi 155 | done 156 | #Username 157 | while [[ $USERVAR = "" ]] || [[ $USERVAR = *[[:space:]]* ]]; 158 | do 159 | read -rp "Enter remote host's ${C}username${D}: " USERVAR 160 | if [ "$USERVAR" = "" ] || [[ "$USERVAR" = *[[:space:]]* ]]; 161 | then 162 | echo "${R}Please enter a username without spaces${D}." 163 | fi 164 | done 165 | #Hostname 166 | while [[ $HOSTVAR = "" ]] || [[ $HOSTVAR = *[[:space:]]* ]]; 167 | do 168 | read -rp "Enter remote host's ${C}hostname${D} (used to name ssh keys and ~/.ssh/config entry): " HOSTVAR 169 | if [ "$HOSTVAR" = "" ] || [[ "$HOSTVAR" = *[[:space:]]* ]]; 170 | then 171 | echo "${R}Please enter a hostname without spaces${D}." 172 | fi 173 | done 174 | echo 175 | sleep 0.5 176 | echo "${G}Configured!${D}" 177 | echo 178 | menuprompt 179 | 180 | } 181 | 182 | # Option 3 183 | 184 | optionthree () { 185 | # First check to see if ~/.ssh exists. 186 | SSHDIRVAR=y 187 | if [ ! -d "$HOME"/.ssh ]; 188 | then 189 | read -rp "${C}$HOME/.ssh${D} ${R}does not exist${D}. This is where our ssh keys and config file should be stored. Create it now? [y/n]: " SSHDIRVAR 190 | 191 | if [ "$SSHDIRVAR" = "y" ] || [ "$SSHDIRVAR" = "Y" ]; 192 | then 193 | echo 194 | echo "Attempting to backup $HOME/.ssh as sshbak to your home folder just in case. ignore the error this will produce, as"\ 195 | "it means $HOME/.ssh doesn't exist, and we're clear to create it." 196 | echo 197 | sleep 1 198 | cp -r "$HOME"/.ssh "$HOME"/sshbak 199 | echo 200 | sleep 1 201 | echo "${C}Creating${D} $HOME/.ssh..." 202 | echo 203 | sleep 1 204 | mkdir "$HOME"/.ssh 205 | echo "${G}Created${D}! Continuing..." 206 | sleep 0.5 207 | 208 | elif [ "$SSHDIRVAR" = "n" ] || [ "$SSHDIRVAR" = "N" ]; 209 | then 210 | echo 211 | echo "${R}Not creating${D}. This tool requires ~/.ssh/ to exist." 212 | echo 213 | echo "Returning..." 214 | echo 215 | sleep 2 216 | else 217 | SSHDIRVAR=y 218 | fi 219 | 220 | elif [ -d "$HOME"/.ssh ]; 221 | then 222 | cd "$HOME"/.ssh 223 | remotevarlist 224 | echo 225 | # Check to see if remote host variables are set 226 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 227 | then 228 | echo "${R}All remote host variables aren't set${D}." 229 | echo 230 | sleep 1 231 | echo "Please run option 2 first." 232 | echo 233 | menuprompt 234 | 235 | else 236 | #Continue with key creation 237 | proceedprompt 238 | echo 239 | echo "${G}Creating${D} keys ${C}${HOSTVAR}${D} & ${C}${HOSTVAR}.pub${D} at ~/.ssh/. An empty passphrase stores keys in plain text." 240 | echo 241 | sleep 0.5 242 | ssh-keygen -f "$HOSTVAR"; 243 | echo 244 | sleep 0.5 245 | echo "${G}Created!${D}" 246 | echo 247 | sleep 0.7 248 | echo "Attempting to send keys to ${C}${IPVAR}${D} on ssh port ${C}${PORTVAR}${D} with username ${C}${USERVAR}${D}." 249 | echo 250 | echo "${P}Note${D}: If this is your first time logging in to ${C}${HOSTVAR}${D}, you'll need to respond 'yes' to add its"\ 251 | "fingerprint to your ~/.ssh/known_hosts file. You'll need to provide ssh with ${C}${USERVAR}${D}'s password on ${C}${IPVAR}${D}." 252 | echo 253 | sleep 0.7 254 | proceedprompt 255 | echo 256 | if ssh-copy-id -i "$HOSTVAR".pub -p "$PORTVAR" "$USERVAR"@"$IPVAR" 257 | then 258 | sleep 0.7 259 | echo "${G}Keys transferred!${D}" 260 | echo 261 | sleep 0.7 262 | echo "${P}Note${D}: Passwordless login via rsa keys won't work until you run option 4 (add ~/.ssh/config entry)." 263 | sleep 0.7 264 | else 265 | sleep 0.7 266 | echo "Key transfer ${R}failed!${D} Please check for errors." 267 | echo 268 | fi 269 | menuprompt 270 | fi 271 | fi 272 | 273 | } 274 | 275 | # Option 4 276 | 277 | optionfour () { 278 | remotevarlist 279 | echo 280 | CONFIGVAR="$HOME"/.ssh/config 281 | # Check to see if remote host variables are set 282 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 283 | then 284 | echo "${R}All remote host variables aren't set${D}." 285 | echo 286 | sleep 1 287 | echo "Please run option 2 first." 288 | echo 289 | menuprompt 290 | 291 | else 292 | proceedprompt 293 | echo 294 | if [ -e "$CONFIGVAR" ]; 295 | then 296 | #Backup ~/.ssh/config 297 | echo "${C}${CONFIGVAR}${D} exists. Backing it up to ~/.ssh/config.bak first, just in case." 298 | cp "$HOME"/.ssh/config "$HOME"/.ssh/config.bak 299 | echo 300 | sleep 0.7 301 | echo "${G}Completed backup!${D} Continuing..." 302 | echo 303 | sleep 0.7 304 | fi 305 | 306 | echo "Adding the following entry to the end of ${C}${CONFIGVAR}${D}:" 307 | sleep 0.7 308 | printf "\nHost\t%s\n\tHostname %s\n\tUser %s\n\tPort %s\n\tIdentityFile %s/.ssh/%s\n" "$HOSTVAR" "$IPVAR" "$USERVAR" "$PORTVAR" "$HOME" "$HOSTVAR" 309 | echo 310 | sleep 0.7 311 | proceedprompt 312 | echo 313 | # Print to ~/.ssh/config 314 | printf "\nHost\t%s\n\tHostname %s\n\tUser %s\n\tPort %s\n\tIdentityFile %s/.ssh/%s\n" "$HOSTVAR" "$IPVAR" "$USERVAR" "$PORTVAR" "$HOME" "$HOSTVAR" >> "$CONFIGVAR" 315 | echo "${G}Entry added!${D} Here's what ${C}${CONFIGVAR}${D} looks like now:" 316 | echo 317 | sleep 0.7 318 | cat "$CONFIGVAR" 319 | echo 320 | sleep 0.7 321 | echo "${R}Important${D}: You can only login to ${C}${HOSTVAR}${D} without a password by executing ${G}ssh ${HOSTVAR}${D}" 322 | echo 323 | echo "'ssh -p ${PORTVAR} ${USERVAR}@${IPVAR}' will prompt you for a password" 324 | echo 325 | sleep 0.7 326 | menuprompt 327 | fi 328 | } 329 | 330 | # Option 5 331 | 332 | optionfive () { 333 | remotevarlist 334 | echo 335 | HOSTFILEVAR=/etc/hosts 336 | # Check to see if remote host variables are set 337 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 338 | then 339 | echo "${R}All remote host variables aren't set${D}." 340 | echo 341 | sleep 1 342 | echo "Please run option 2 first." 343 | echo 344 | menuprompt 345 | 346 | else 347 | proceedprompt 348 | echo 349 | if [ -e "$HOSTFILEVAR" ]; 350 | then 351 | #Backup /etc/hosts 352 | echo "${C}${HOSTFILEVAR}${D} exists. Backing it up to /etc/hosts.bak, just in case." 353 | echo 354 | echo "${R}Important${D}: By default on most systems, ${C}${HOSTFILEVAR}${D} is owned by root. This means all regular users"\ 355 | "need to use ${C}sudo${D} to manipulate the file. You may be asked for your password to access the file now." 356 | sudo cp /etc/hosts /etc/hosts.bak 357 | echo 358 | sleep 0.7 359 | echo "${G}Completed backup${D}! Continuing..." 360 | echo 361 | sleep 0.7 362 | fi 363 | 364 | echo "Adding the following entry to the end of ${C}${HOSTFILEVAR}${D}:" 365 | sleep 0.7 366 | echo 367 | echo "${IPVAR} ${HOSTVAR}" 368 | echo 369 | sleep 0.7 370 | proceedprompt 371 | echo 372 | echo "$IPVAR" "$HOSTVAR" | sudo tee -a /etc/hosts >/dev/null 373 | echo "${G}Entry added${D}! Here's what ${C}${HOSTFILEVAR}${D} looks like now:" 374 | echo 375 | sleep 0.7 376 | sudo cat "$HOSTFILEVAR" 377 | echo 378 | sleep 0.7 379 | echo "${P}Note${D}: You can now type ${C}${HOSTVAR}${D} instead of ${C}${IPVAR}${D} where necessary." 380 | echo 381 | sleep 0.7 382 | menuprompt 383 | fi 384 | } 385 | 386 | # Option 6 - Autosetup function - runs all options with minimal prompting 387 | 388 | autosetup () { 389 | #Set variables 390 | PORTVAR= 391 | IPVAR= 392 | USERVAR= 393 | HOSTVAR= 394 | #Port 395 | while [[ $PORTVAR = "" ]] || [[ ! "$PORTVAR" =~ ^-?[0-9]+$ ]]; 396 | do 397 | read -rp "Enter remote host's ${C}ssh port${D}: " PORTVAR 398 | if [ "$PORTVAR" = "" ] || [[ ! "$PORTVAR" =~ ^-?[0-9]+$ ]]; 399 | then 400 | echo "${R}Please enter a number${D}." 401 | fi 402 | done 403 | #IP 404 | while [[ $IPVAR = "" ]] || [[ ! $IPVAR =~ ^-?[0-9.]+$ ]]; 405 | do 406 | read -rp "Enter remote host's ${C}IP address${D}: " IPVAR 407 | if [ "$IPVAR" = "" ] || [[ ! "$IPVAR" =~ ^-?[0-9.]+$ ]]; 408 | then 409 | echo "${R}Please enter an ip (x.x.x.x)${D}." 410 | fi 411 | done 412 | #Username 413 | while [[ $USERVAR = "" ]] || [[ $USERVAR = *[[:space:]]* ]]; 414 | do 415 | read -rp "Enter remote host's ${C}username${D}: " USERVAR 416 | if [ "$USERVAR" = "" ] || [[ "$USERVAR" = *[[:space:]]* ]]; 417 | then 418 | echo "${R}Please enter a username without spaces${D}." 419 | fi 420 | done 421 | #Hostname 422 | while [[ $HOSTVAR = "" ]] || [[ $HOSTVAR = *[[:space:]]* ]]; 423 | do 424 | read -rp "Enter remote host's ${C}hostname${D} (used to name ssh keys and ~/.ssh/config entry): " HOSTVAR 425 | if [ "$HOSTVAR" = "" ] || [[ "$HOSTVAR" = *[[:space:]]* ]]; 426 | then 427 | echo "${R}Please enter a hostname without spaces${D}." 428 | fi 429 | done 430 | echo 431 | sleep 0.5 432 | echo "${G}Configured!${D}" 433 | #Create keys 434 | SSHDIRVAR=y 435 | if [ ! -d "$HOME"/.ssh ]; 436 | then 437 | read -rp "${C}$HOME/.ssh${D} ${R}does not exist${D}. This is where our ssh keys and config file should be stored. Create it now? [y/n]: " SSHDIRVAR 438 | 439 | if [ "$SSHDIRVAR" = "y" ] || [ "$SSHDIRVAR" = "Y" ]; 440 | then 441 | echo 442 | echo "Attempting to backup $HOME/.ssh as sshbak to your home folder just in case. ignore the error this will produce, as"\ 443 | "it means $HOME/.ssh doesn't exist, and we're clear to create it." 444 | echo 445 | sleep 1 446 | cp -r "$HOME"/.ssh "$HOME"/sshbak 447 | echo 448 | sleep 1 449 | echo "${C}Creating${D} $HOME/.ssh..." 450 | echo 451 | sleep 1 452 | mkdir "$HOME"/.ssh 453 | echo "${G}Created${D}! Continuing..." 454 | sleep 0.5 455 | 456 | elif [ "$SSHDIRVAR" = "n" ] || [ "$SSHDIRVAR" = "N" ]; 457 | then 458 | echo 459 | echo "${R}Not creating${D}. This tool requires ~/.ssh/ to exist." 460 | echo 461 | echo "Returning..." 462 | echo 463 | sleep 2 464 | else 465 | SSHDIRVAR=y 466 | fi 467 | elif [ -d "$HOME"/.ssh ]; 468 | then 469 | cd "$HOME"/.ssh 470 | remotevarlist 471 | echo 472 | # Check to see if remote host variables are set 473 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 474 | then 475 | echo "${R}All remote host variables aren't set${D}." 476 | echo 477 | sleep 1 478 | echo "Please run option 2 first." 479 | echo 480 | menuprompt 481 | else 482 | #Continue with key creation 483 | proceedprompt 484 | echo 485 | echo "${G}Creating${D} keys ${C}${HOSTVAR}${D} & ${C}${HOSTVAR}.pub${D} at ~/.ssh/. An empty passphrase stores keys in plain text." 486 | echo 487 | sleep 0.5 488 | ssh-keygen -f "$HOSTVAR"; 489 | echo 490 | sleep 0.5 491 | echo "${G}Created!${D}" 492 | echo 493 | sleep 0.7 494 | echo "Attempting to send keys to ${C}${IPVAR}${D} on ssh port ${C}${PORTVAR}${D} with username ${C}${USERVAR}${D}." 495 | echo 496 | echo "${P}Note${D}: If this is your first time logging in to ${C}${HOSTVAR}${D}, you'll need to respond 'yes' to add its"\ 497 | "fingerprint to your ~/.ssh/known_hosts file. You'll need to provide ssh with ${C}${USERVAR}${D}'s password on ${C}${IPVAR}${D}." 498 | echo 499 | sleep 0.7 500 | if ssh-copy-id -i "$HOSTVAR".pub -p "$PORTVAR" "$USERVAR"@"$IPVAR" 501 | then 502 | sleep 0.7 503 | echo "${G}Keys transferred!${D}" 504 | echo 505 | sleep 0.7 506 | echo "${P}Note${D}: Passwordless login via rsa keys won't work until you run option 4 (add ~/.ssh/config entry)." 507 | sleep 0.7 508 | else 509 | sleep 0.7 510 | echo "Key transfer ${R}failed!${D} Please check for errors." 511 | fi 512 | fi 513 | fi 514 | # Config entry 515 | echo 516 | CONFIGVAR="$HOME"/.ssh/config 517 | # Check to see if remote host variables are set 518 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 519 | then 520 | echo "${R}All remote host variables aren't set${D}." 521 | echo 522 | sleep 1 523 | echo "Please run option 2 first." 524 | echo 525 | menuprompt 526 | else 527 | if [ -e "$CONFIGVAR" ]; 528 | then 529 | #Backup ~/.ssh/config 530 | echo "${C}${CONFIGVAR}${D} exists. Backing it up to ~/.ssh/config.bak first, just in case." 531 | cp "$HOME"/.ssh/config "$HOME"/.ssh/config.bak 532 | echo 533 | sleep 0.7 534 | echo "${G}Completed backup!${D} Continuing..." 535 | echo 536 | sleep 0.7 537 | fi 538 | 539 | echo "Adding the entry to the end of ${C}${CONFIGVAR}${D}" 540 | sleep 0.7 541 | echo 542 | # Print to ~/.ssh/config 543 | printf "\nHost\t%s\n\tHostname %s\n\tUser %s\n\tPort %s\n\tIdentityFile %s/.ssh/%s\n" "$HOSTVAR" "$IPVAR" "$USERVAR" "$PORTVAR" "$HOME" "$HOSTVAR" >> "$CONFIGVAR" 544 | echo "${G}Entry added!${D} Here's what ${C}${CONFIGVAR}${D} looks like now:" 545 | echo 546 | sleep 0.7 547 | cat "$CONFIGVAR" 548 | echo 549 | sleep 0.7 550 | echo "${R}Important${D}: You can only login to ${C}${HOSTVAR}${D} without a password by executing ${G}ssh ${HOSTVAR}${D}" 551 | echo 552 | echo "'ssh -p ${PORTVAR} ${USERVAR}@${IPVAR}' will prompt you for a password" 553 | echo 554 | sleep 0.7 555 | fi 556 | # Host entry 557 | echo 558 | HOSTFILEVAR=/etc/hosts 559 | # Check to see if remote host variables are set 560 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 561 | then 562 | echo "${R}All remote host variables aren't set${D}." 563 | echo 564 | sleep 1 565 | echo "Please run option 2 first." 566 | echo 567 | menuprompt 568 | else 569 | if [ -e "$HOSTFILEVAR" ]; 570 | then 571 | #Backup /etc/hosts 572 | echo "${C}${HOSTFILEVAR}${D} exists. Backing it up to /etc/hosts.bak, just in case." 573 | echo 574 | echo "${R}Important${D}: By default on most systems, ${C}${HOSTFILEVAR}${D} is owned by root. This means all regular users"\ 575 | "need to use ${C}sudo${D} to manipulate the file. You may be asked for your password to access the file now." 576 | sudo cp /etc/hosts /etc/hosts.bak 577 | echo 578 | sleep 0.7 579 | echo "${G}Completed backup${D}! Continuing..." 580 | echo 581 | sleep 0.7 582 | fi 583 | 584 | echo "Adding the entry to the end of ${C}${HOSTFILEVAR}${D}" 585 | sleep 0.7 586 | echo 587 | echo "$IPVAR" "$HOSTVAR" | sudo tee -a /etc/hosts >/dev/null 588 | echo "${G}Entry added${D}! Here's what ${C}${HOSTFILEVAR}${D} looks like now:" 589 | echo 590 | sleep 0.7 591 | sudo cat "$HOSTFILEVAR" 592 | echo 593 | sleep 0.7 594 | echo "${P}Note${D}: You can now type ${C}${HOSTVAR}${D} instead of ${C}${IPVAR}${D} where necessary." 595 | echo 596 | sleep 0.7 597 | echo "${G}Complete!${D}" 598 | echo 599 | sleep 0.7 600 | menuprompt 601 | fi 602 | 603 | } 604 | 605 | ### Option Functions - whiptail 606 | 607 | # Option 1 - whiptail 608 | 609 | optiononewhip () { 610 | if (whiptail --title "Install/Upgrade OpenSSH-Server" --yesno "Install or upgrade the openssh-server package?\n\nNOTE: You may need to provide your password to the terminal as sudo apt-get requires root permission." 10 78); then 611 | sudo apt-get install openssh-server 612 | echo 613 | else 614 | : 615 | fi 616 | } 617 | 618 | # Option 2 - whiptail 619 | 620 | optiontwowhip () { 621 | INPUTPORT= 622 | INPUTIP= 623 | INPUTUSER= 624 | INPUTHOST= 625 | 626 | #Port 627 | while [[ "$INPUTPORT" = "" ]] || [[ ! "$INPUTPORT" =~ ^-?[0-9]+$ ]]; 628 | do 629 | INPUTPORT=$(whiptail --inputbox "Enter remote host's SSH port:" 8 78 --nocancel --title "Remote Host Variables" 3>&1 1>&2 2>&3) 630 | exitstatus=$? 631 | if [ $exitstatus = 0 ]; then 632 | 633 | if [ "$INPUTPORT" = "" ] || [[ ! "$INPUTPORT" =~ ^-?[0-9]+$ ]]; 634 | then 635 | whiptail --title "Error" --msgbox "Please only enter numbers." 8 78 636 | else 637 | PORTVAR=${INPUTPORT} 638 | echo "Port=${PORTVAR}" 639 | fi 640 | 641 | else 642 | : 643 | fi 644 | done 645 | 646 | #IP 647 | while [[ "$INPUTIP" = "" ]] || [[ ! "$INPUTIP" =~ ^-?[0-9.]+$ ]]; 648 | do 649 | INPUTIP=$(whiptail --inputbox "Enter remote host's IP address:" 8 78 --nocancel --title "Remote Host Variables" 3>&1 1>&2 2>&3) 650 | exitstatus=$? 651 | if [ $exitstatus = 0 ]; then 652 | 653 | if [ "$INPUTIP" = "" ] || [[ ! "$INPUTIP" =~ ^-?[0-9.]+$ ]]; 654 | then 655 | whiptail --title "Error" --msgbox "Please enter an ip (x.x.x.x)" 8 78 656 | else 657 | IPVAR=${INPUTIP} 658 | echo "IP=${IPVAR}" 659 | fi 660 | 661 | else 662 | : 663 | fi 664 | done 665 | 666 | #Username 667 | while [[ "$INPUTUSER" = "" ]] || [[ "$INPUTUSER" = *[[:space:]]* ]]; 668 | do 669 | INPUTUSER=$(whiptail --inputbox "Enter remote host's Username:" 8 78 --nocancel --title "Remote Host Variables" 3>&1 1>&2 2>&3) 670 | exitstatus=$? 671 | if [ $exitstatus = 0 ]; then 672 | 673 | if [ "$INPUTUSER" = "" ] || [[ "$INPUTUSER" = *[[:space:]]* ]]; 674 | then 675 | whiptail --title "Error" --msgbox "Please enter a username without spaces." 8 78 676 | else 677 | USERVAR=${INPUTUSER} 678 | echo "User=${USERVAR}" 679 | fi 680 | 681 | else 682 | : 683 | fi 684 | done 685 | 686 | #Hostname 687 | while [[ "$INPUTHOST" = "" ]] || [[ "$INPUTHOST" = *[[:space:]]* ]]; 688 | do 689 | INPUTHOST=$(whiptail --inputbox "Enter remote host's Hostname:" 8 78 --nocancel --title "Remote Host Variables" 3>&1 1>&2 2>&3) 690 | exitstatus=$? 691 | if [ $exitstatus = 0 ]; then 692 | 693 | if [ "$INPUTHOST" = "" ] || [[ "$INPUTHOST" = *[[:space:]]* ]]; 694 | then 695 | whiptail --title "Error" --msgbox "Please enter a hostname without spaces." 8 78 696 | else 697 | HOSTVAR=${INPUTHOST} 698 | echo "Hostname=${HOSTVAR}" 699 | echo 700 | fi 701 | 702 | else 703 | : 704 | fi 705 | done 706 | } 707 | 708 | # Option 3 - whiptail 709 | 710 | optionthreewhip () { 711 | if [ ! -d "$HOME"/.ssh ]; 712 | then 713 | if (whiptail --title "Create ${HOME}/.ssh?" --yesno "$HOME/.ssh does not exist. Create it now?" 8 78); 714 | then 715 | mkdir "$HOME"/.ssh 716 | if [ "$?" = 0 ]; 717 | then 718 | whiptail --title "Create ${HOME}/.ssh?" --msgbox "Created! Continuing" 8 78 719 | echo "${HOME}/.ssh ${G}created${D}!" 720 | echo 721 | else 722 | whiptail --title "Failure!" --msgbox "Could not create ${HOME}/.ssh. Please check your user permissions." 8 78 723 | echo "${HOME}/.ssh creation ${R}failed${D}! Please check your user permissions." 724 | echo 725 | fi 726 | else 727 | whiptail --title "$HOME/.ssh" --msgbox "Not creating. This tool requires ${HOME}/.ssh exists." 8 78 728 | echo "${HOME}/.ssh ${R}doesn't exist${D}, and ${R}isn't${D} being created by user request." 729 | echo 730 | fi 731 | fi 732 | 733 | if [ -d "$HOME"/.ssh ]; 734 | then 735 | cd "$HOME"/.ssh 736 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 737 | then 738 | whiptail --title "No Variables Set" --msgbox "Please set remote host variables before running this option." 8 78 739 | else 740 | if (whiptail --title "Create SSH Keys" --yesno "Create the following SSH keys?\n\n$HOME/.ssh/$HOSTVAR\n$HOME/.ssh/$HOSTVAR.pub\n\nIf they already exist, you'll need to respond 'y' or 'n' to overwrite them." 13 78); then 741 | ssh-keygen -f "$HOSTVAR" -q -N "" 742 | echo 743 | if [ -e "$HOME"/.ssh/"$HOSTVAR".pub ] && [ -e "$HOME"/.ssh/"$HOSTVAR" ]; 744 | then 745 | printf "${G}SSH keys created successfully${D}:\n%s/.ssh/%s (private)\n%s/.ssh/%s.pub (public)\n" "$HOME" "$HOSTVAR" "$HOME" "$HOSTVAR" 746 | echo 747 | if (whiptail --title "Transfer" --yesno "Transfer $HOME/.ssh/$HOSTVAR.pub to $USERVAR@$IPVAR on port $PORTVAR?\n\nYou'll need to respond yes to the fingerprint prompt, and provide $USERVAR's password on $IPVAR to the terminal." 12 78); then 748 | ssh-copy-id -i "$HOSTVAR".pub -p "$PORTVAR" "$USERVAR"@"$IPVAR" 749 | if [ "$?" = 0 ]; 750 | then 751 | printf "${G}SSH keys transferred successfully${D}:\n%s/.ssh/%s.pub to %s@%s on port %s\n" "$HOME" "$HOSTVAR" "$USERVAR" "$IPVAR" "$PORTVAR" 752 | echo 753 | whiptail --title "Success!" --msgbox "Keys successfully transfered!\n\nPlease run the SSH Config File option to enable passwordless login." 10 78 754 | else 755 | whiptail --title "Failure!" --msgbox "SSH key transfer failed. Please check your variables and/or password." 10 78 756 | echo "${R}SSH key transfer failed${D}. Please check your variables and/or password." 757 | echo 758 | fi 759 | fi 760 | else 761 | whiptail --title "Failure!" --msgbox "SSH key creation failed. Please check your variables and/or permissions." 10 78 762 | echo "${R}SSH key creation failed${D}. Please check your variables and/or permissions" 763 | echo 764 | fi 765 | else 766 | whiptail --title "Create SSH Keys" --msgbox "Not creating. This options requires SSH keys be created." 8 78 767 | echo "${R}${HOME}SSH keys not created${D} by user request. This option requires SSH keys be created." 768 | echo 769 | fi 770 | fi 771 | fi 772 | } 773 | 774 | # Option 4 - whiptail 775 | 776 | optionfourwhip () { 777 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 778 | then 779 | whiptail --title "No Variables Set" --msgbox "Please set remote host variables before running this option." 8 78 780 | else 781 | CONFIGVAR="$HOME"/.ssh/config 782 | if [ ! -e "$CONFIGVAR" ]; 783 | then 784 | whiptail --title "$HOME/.ssh/config" --msgbox "${CONFIGVAR} does not exist. Creating it now and continuing." 8 78 785 | touch "$HOME"/.ssh/config 786 | echo "${CONFIGVAR} ${R}doesn't exist${D}. ${G}Created${D}!" 787 | echo 788 | fi 789 | CONFIGENTRYWHIP=$(printf "\nHost %s\n\tHostname %s\n\tUser %s\n\tPort %s\n\tIdentityFile %s/.ssh/%s\n" "$HOSTVAR" "$IPVAR" "$USERVAR" "$PORTVAR" "$HOME" "$HOSTVAR") 790 | if (whiptail --title "$HOME/.ssh/config" --yesno "Add the following entry to $CONFIGVAR?\n\n$CONFIGENTRYWHIP" 15 78); 791 | then 792 | whiptail --title "$HOME/.ssh/config" --msgbox "Backing up config to config.bak first, then adding the entry." 8 78 793 | cp "$HOME"/.ssh/config "$HOME"/.ssh/config.bak 794 | if [ "$?" = 0 ]; 795 | then 796 | echo "${G}${CONFIGVAR}${D} backed up to ${G}${CONFIGVAR}.bak${D}" 797 | echo 798 | whiptail --title "$HOME/.ssh/config" --msgbox "Backup complete! Now we'll add the entry..." 8 78 799 | printf "\nHost\t%s\n\tHostname %s\n\tUser %s\n\tPort %s\n\tIdentityFile %s/.ssh/%s\n" "$HOSTVAR" "$IPVAR" "$USERVAR" "$PORTVAR" "$HOME" "$HOSTVAR" >> "$CONFIGVAR" 800 | if [ "$?" = 0 ]; 801 | then 802 | whiptail --title "$HOME/.ssh/config" --msgbox "Entry added! You can now use 'ssh ${HOSTVAR}' to login without a password on ${IPVAR}" 9 78 803 | echo "The following entry was ${G}added${D} to ${CONFIGVAR}:" 804 | printf "\nHost\t%s\n\tHostname %s\n\tUser %s\n\tPort %s\n\tIdentityFile %s/.ssh/%s\n" "$HOSTVAR" "$IPVAR" "$USERVAR" "$PORTVAR" "$HOME" "$HOSTVAR" 805 | echo 806 | else 807 | whiptail --title "$HOME/.ssh/config" --msgbox "Could not add entry to ${CONFIGVAR}. check that it's owned by $USER." 8 78 808 | echo "${R}Could not${D} add entry to ${CONFIGVAR}. Please check its permissions." 809 | echo 810 | fi 811 | else 812 | whiptail --title "$HOME/.ssh/config" --msgbox "Backup of ${CONFIGVAR} failed. check that it's owned by $USER." 8 78 813 | echo "Backup of ${CONFIGVAR} ${R}failed${D}. Please check its permissions." 814 | echo 815 | fi 816 | else 817 | whiptail --title "$HOME/.ssh/config" --msgbox "Not adding. Add an entry to ${CONFIGVAR} if you want passwordless login via SSH keys." 10 78 818 | echo "${R}Entry not added to ${CONFIGVAR}${D} by user request." 819 | echo 820 | fi 821 | fi 822 | } 823 | 824 | # Option 5 - whiptail 825 | 826 | optionfivewhip () { 827 | if [ -z ${PORTVAR+x} ] && [ -z ${IPVAR+x} ] && [ -z ${USERVAR+x} ] && [ -z ${HOSTVAR+x} ]; 828 | then 829 | whiptail --title "No Variables Set" --msgbox "Please set remote host variables before running this option." 8 78 830 | else 831 | HOSTFILEVAR=/etc/hosts 832 | if (whiptail --title "/etc/hosts" --yesno "Add the following entry to $CONFIGVAR?\n\n$IPVAR $HOSTVAR" 10 78); 833 | then 834 | whiptail --title "/etc/hosts" --msgbox "Backing up ${HOSTFILEVAR} to ${HOSTFILEVAR}.bak first, then adding the entry.\n\nNOTE: You'll need to provide your password to the terminal as /etc/hosts belongs to root." 12 78 835 | sudo cp /etc/hosts /etc/hosts.bak 836 | if [ "$?" = 0 ]; 837 | then 838 | echo "${G}${HOSTFILEVAR}${D} backed up to ${G}${HOSTFILEVAR}.bak${D}" 839 | echo 840 | whiptail --title "/etc/hosts" --msgbox "Backup complete! Now we'll add the entry..." 8 78 841 | echo "$IPVAR" "$HOSTVAR" | sudo tee -a /etc/hosts >/dev/null 842 | if [ "$?" = 0 ]; 843 | then 844 | whiptail --title "/etc/hosts" --msgbox "Entry added! You can now type ${HOSTVAR} instead of ${IPVAR} where necessary." 9 78 845 | echo "The following entry was ${G}added${D} to ${HOSTFILEVAR}:" 846 | echo "${IPVAR} ${HOSTVAR}" 847 | echo 848 | else 849 | whiptail --title "/etc/hosts" --msgbox "Could not add entry to ${HOSTFILEVAR}. Did you provide the correct password?" 8 78 850 | echo "${R}Could not${D} add entry to ${HOSTFILEVAR}. Check your password." 851 | echo 852 | fi 853 | else 854 | whiptail --title "/etc/hosts" --msgbox "Backup of ${HOSTFILEVAR} failed. Did you provide the correct password?" 8 78 855 | echo "Backup of ${CONFIGVAR} ${R}failed${D}. Check your password?" 856 | echo 857 | fi 858 | else 859 | whiptail --title "/etc/hosts" --msgbox "Not adding. Add an entry to ${HOSTFILEVAR} if you want to use ${HOSTVAR} instead of ${IPVAR} where necessary." 10 78 860 | echo "${R}Entry not added to ${HOSTFILEVAR}${D} by user request." 861 | echo 862 | fi 863 | fi 864 | } 865 | 866 | # Option 6 - whiptail 867 | 868 | optionsixwhip () { 869 | echo "${P}Goodbye${D}!" 870 | } 871 | 872 | ############################ 873 | # Main # 874 | ############################ 875 | 876 | ### macOS ### 877 | 878 | if [[ $OSTYPE == darwin* ]]; 879 | then 880 | 881 | while [ "$ANS" != "7" ]; 882 | do 883 | 884 | # Present main menu 885 | clear 886 | border "SSH Setup Tool - macOS" 887 | echo 888 | echo "${G}1${D} - Install/Update openssh-server (Linux apt-get)" 889 | echo "${G}2${D} - Configure remote host variables" 890 | echo "${G}3${D} - Setup ssh keys in ~/.ssh & transfer to remote host" 891 | echo "${G}4${D} - Add remote host entry to ~/.ssh/config" 892 | echo "${G}5${D} - Add remote host entry to /etc/hosts" 893 | echo "${G}6${D} - Auto Setup. Runs options 2-5 with minimal prompting" 894 | echo "${G}7${D} - Quit" 895 | echo 896 | read -rp "Selection: " ANS 897 | 898 | case $ANS in 899 | 900 | ## 1. Install/Update openssh-server (sshd) 901 | 902 | 1) 903 | 904 | clear 905 | border "Install/Update openSSH Server" 906 | echo 907 | optionone 908 | ;; 909 | 910 | ## 2. Configure remote host variables 911 | 912 | 2) 913 | 914 | clear 915 | border "Configure Remote Host Variables" 916 | echo 917 | optiontwo 918 | ;; 919 | 920 | ## 3. Setup & send ssh keys to remote host 921 | 922 | 3) 923 | 924 | clear 925 | border "Setup & Send SSH Keys" 926 | echo 927 | optionthree 928 | ;; 929 | 930 | ## 4. Add remote host entry to ~/.ssh/config 931 | 932 | 4) 933 | 934 | clear 935 | border "Add Entry to ~/.ssh/config" 936 | echo 937 | optionfour 938 | ;; 939 | 940 | ## 5. Add remote host entry to /etc/hosts 941 | 942 | 5) 943 | 944 | clear 945 | border "Add Entry to /etc/hosts" 946 | echo 947 | optionfive 948 | ;; 949 | 950 | ## 6. Auto Setup 951 | 952 | 6) 953 | 954 | clear 955 | border "Auto Setup" 956 | echo 957 | autosetup 958 | ;; 959 | 960 | ## 7. Quitting 961 | 962 | 7) 963 | 964 | echo 965 | echo "Quitting..." 966 | echo 967 | sleep 0.7 968 | ;; 969 | 970 | ## Invalid selection 971 | 972 | *) 973 | 974 | echo 975 | echo "${R}Invalid selection{$D}." 976 | sleep 0.7 977 | ;; 978 | 979 | esac 980 | done 981 | 982 | ### Linux ### 983 | 984 | elif [[ $OSTYPE == linux* ]]; 985 | then 986 | 987 | dpkg-query -l whiptail >/dev/null 2>&1 988 | # If whiptail is installed 989 | if [ "$?" = "0" ]; 990 | then 991 | 992 | while [ "$ANSWHIP" != "Exit" ] || [ "$ANSWHIP" = "1" ]; 993 | do 994 | 995 | # Present main menu 996 | ANSWHIP=$(whiptail --title "SSH Setup Tool - Linux" --menu "Choose an option [Enter]" --nocancel 25 80 16 3>&1 1>&2 2>&3 \ 997 | "OpenSSH-Server" "Install/Upgrade OpenSSH-Server package" \ 998 | "Set Variables" "Set remote host Port, IP, Username, & Hostname" \ 999 | "SSH Keys" "Setup & transfer SSH keys" \ 1000 | "SSH Config File" "Add remote host entry to ~/.ssh/config" \ 1001 | "Hosts File" "Add remote host entry to /etc/hosts" \ 1002 | "Auto Setup" "Streamline 2-5 on the terminal with minimal prompting"\ 1003 | "Exit" "Quit the program") 1004 | case $ANSWHIP in 1005 | 1006 | ## 1. Install/Update openssh-server (sshd) 1007 | 1008 | "OpenSSH-Server") 1009 | 1010 | optiononewhip 1011 | ;; 1012 | 1013 | ## 2. Configure remote host variables 1014 | 1015 | "Set Variables") 1016 | 1017 | optiontwowhip 1018 | ;; 1019 | 1020 | ## 3. Setup & send ssh keys to remote host 1021 | 1022 | "SSH Keys") 1023 | 1024 | optionthreewhip 1025 | ;; 1026 | 1027 | ## 4. Add remote host entry to ~/.ssh/config 1028 | 1029 | "SSH Config File") 1030 | 1031 | optionfourwhip 1032 | ;; 1033 | 1034 | ## 5. Add remote host entry to /etc/hosts 1035 | 1036 | "Hosts File") 1037 | 1038 | optionfivewhip 1039 | ;; 1040 | 1041 | ## 6. Auto Setup 1042 | 1043 | "Auto Setup") 1044 | 1045 | clear 1046 | border "Auto Setup" 1047 | echo 1048 | autosetup 1049 | ;; 1050 | 1051 | ## 7. Quitting 1052 | 1053 | "Exit") 1054 | 1055 | optionsixwhip 1056 | ;; 1057 | 1058 | ## Invalid selection 1059 | 1060 | *) 1061 | 1062 | : 1063 | ;; 1064 | 1065 | esac 1066 | done 1067 | 1068 | # If whiptail is NOT installed 1069 | 1070 | elif [ "$?" = "1" ]; 1071 | then 1072 | 1073 | while [ "$ANS" != "7" ]; 1074 | do 1075 | 1076 | # Present main menu 1077 | clear 1078 | border "SSH Setup Tool - Linux" 1079 | echo 1080 | echo "${G}1${D} - Install/Update openssh-server (Linux apt-get)" 1081 | echo "${G}2${D} - Configure remote host variables" 1082 | echo "${G}3${D} - Setup ssh keys in ~/.ssh & transfer to remote host" 1083 | echo "${G}4${D} - Add remote host entry to ~/.ssh/config" 1084 | echo "${G}5${D} - Add remote host entry to /etc/hosts" 1085 | echo "${G}6${D} - Auto Setup. Runs options 2-5 with minimal prompting" 1086 | echo "${G}7${D} - Quit" 1087 | echo 1088 | read -rp "Selection: " ANS 1089 | 1090 | case $ANS in 1091 | 1092 | ## 1. Install/Update openssh-server (sshd) 1093 | 1094 | 1) 1095 | 1096 | clear 1097 | border "Install/Update openSSH Server" 1098 | echo 1099 | optionone 1100 | ;; 1101 | 1102 | ## 2. Configure remote host variables 1103 | 1104 | 2) 1105 | 1106 | clear 1107 | border "Configure Remote Host Variables" 1108 | echo 1109 | optiontwo 1110 | ;; 1111 | 1112 | ## 3. Setup & send ssh keys to remote host 1113 | 1114 | 3) 1115 | 1116 | clear 1117 | border "Setup & Send SSH Keys" 1118 | echo 1119 | optionthree 1120 | ;; 1121 | 1122 | ## 4. Add remote host entry to ~/.ssh/config 1123 | 1124 | 4) 1125 | 1126 | clear 1127 | border "Add Entry to ~/.ssh/config" 1128 | echo 1129 | optionfour 1130 | ;; 1131 | 1132 | ## 5. Add remote host entry to /etc/hosts 1133 | 1134 | 5) 1135 | 1136 | clear 1137 | border "Add Entry to /etc/hosts" 1138 | echo 1139 | optionfive 1140 | ;; 1141 | 1142 | ## 6. Auto Setup 1143 | 1144 | 6) 1145 | 1146 | clear 1147 | border "Auto Setup" 1148 | echo 1149 | autosetup 1150 | ;; 1151 | 1152 | ## 7. Quitting 1153 | 1154 | 7) 1155 | 1156 | echo 1157 | echo "Quitting..." 1158 | echo 1159 | sleep 0.7 1160 | ;; 1161 | 1162 | ## Invalid selection 1163 | 1164 | *) 1165 | 1166 | echo 1167 | echo "${R}Invalid selection{$D}." 1168 | sleep 0.7 1169 | ;; 1170 | 1171 | esac 1172 | done 1173 | 1174 | fi 1175 | 1176 | ### Neither Linux or macOS 1177 | 1178 | else 1179 | echo "${C}OSTYPE${D} doesn't return Darwin or Linux. ${R}Exiting${D}..." 1180 | sleep 0.7 1181 | fi 1182 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------