SSH Secure Shell Client 1 Introduction An SSH Secure Shell Client is a piece of software that allows a user to do a number of functions. Some of these functions are: file transferring, setting permissions, accessing various file types, programming, sending e-mail, and many more. Furthermore, with this manual, I intend on coveringthe following topics: Accessing a Server Moving Around the Shell Transferring Files Using Text Editing and Creating Programs Setting Permissions Using E-mail In order to gain access, you must have an account that has the capabilities for UNIX commands. This is because the shell is command prompt. This means that in order to use the shell, you must have an understanding of a few basic UNIX commands. From there, you can do a number of UNIX based operations. If you have little or no experience with either UNIX, a command prompt environment, or file transferring, that is not a problem. The manual will cover these areas. Once you have an understanding of these areas, you will be able to use other programs that are similar to an SSH Secure Shell Client. This would include a variety of FTP programs or any basic UNIX shell. Throughout this manual, I will go on the assumption that you have a UNIX based account. Furthermore, I will assume that you have already downloaded the SSH Secure Shell Client program. If you do not, it can be downloaded from the SSH Secure Shell Client official site at www.ssh.com for a free download.
2 SSH Secure Shell Client Accessing a Server Using Quick Connect When first opening the SSH Secure Shell Client program, you need a simple way of signing into your account. The Quick Connect option allows for this, opening a window titled Connect to Remote Host: Click the Quick Connect icon, located in the upper left corner, to access this option. You can also access this by clicking the File Menu and then clicking Quick Connect. Entering Host Name Under the Connect to Remote Host window, you need to enter the host name of the server you want to access. Under the Host Name text field, enter in the specified host name for the server. Entering User Name Also under the Connect to Remote Host window, you need to enter your user name that the server can recognize. Under the User Name text field, enter in your user name for the server. Entering Port Number In the Connect to Remote Host window, you need to enter the specific home port number for the server you are trying to access. The program has a default of 22, which is the common port number for most servers. To input a specific port number, modify the Port Number text field.
SSH Secure Shell Client 3 Entering Authentication Method You need to specify a certain authentication method to access the server with. Although there are several options for this, it is recommended to choose the Password option. Under the Connect to Remote Host window, click the pull down menu under the Authentication Method label. Once open choose the Password option. This is an example of a correctly filled out Connect to Remote Host window Entering Password Once all of the above fields are filled in, press the Connect button. Once pressed the user will be prompted to enter a password. In the password text field, enter the password associated with your user name. Setting up Profiles A convenient way of storing server information is to establish a profile. This way, you don t have to enter the same server information mentioned above every time you open the SSH Secure Shell Client.
4 SSH Secure Shell Client Adding Profiles In order to add a profile, you must logged into the server you would like to add. There are a number of ways to add a profile: To access the add profile option, click the Profiles icon on the toolbar, and then click the Add Profile option. Another way of accessing the Add Profile option, is to go through the File Menu and click the Profiles menu. Under the Profiles menu, click the Add Profile option. Once Add Profile is open, enter desired Profile Name and click Add to Profiles button. Editing a Profile In order to edit a profile, you must already have an existing profile. Editing a profile allows you to make any modifications of Host Name, User Name, Port Number, and Authentication Method. To access the edit profile option, click the Profiles icon on the toolbar, and then click the Edit Profiles option.
SSH Secure Shell Client 5 Another way of accessing the Edit Profiles option, is to go through the File Menu and click the Profiles menu. Under the Profiles menu, click the Edit Profiles option. Make any desired changes.
6 SSH Secure Shell Client
SSH Secure Shell Client 7 Moving Around the Shell Understanding a Command Prompt Environment Sometimes it can be a difficult transition to go from a Windows environment to a UNIX environment. There are certain similarities between the two, however. In Windows, when you are viewing folders through the Explorer Program, these folders represent directories in UNIX. Directories are effectively the same things as folders. Here s a visual depicting this system: When you first log into the server, the server s host will have set the directory you re in. This directory is the current working directory for the user. Using UNIX Commands Here is a list of commonly used UNIX commands and their meanings: cd change directory ls list directory contents cat view contents of a file vi commonly used UNIX text editor chmod Change Permissions on a file cp make a copy of a file rm remove a file(s) mkdir create a directory
8 SSH Secure Shell Client Navigating through Directories It is vital to quickly and efficiently navigate through a server s directories. The command to do so is cd, which stands for change directory. There are several different ways of using this. cd [dirname] From your current working directory, this will move to the [dirname] directory. Note that [dirname] should be located in your current working directory. cd / This changes the current directory to the root directory. The root directory is the highest level directory hierarchy. cd.. This moves back to the previous directory you were in. Creating Directories mkdir is the command to make directories. The directory you are currently in will be the location of the directory you make. Here is the syntax for making directories: mkdir [dirname] [dirname] is the name of the directory you want to create Viewing Directory There are a number of ways to view the contents in a directory. The ls command is the most common way to do this, but there are a number of ways to use the ls command. ls (no parameters)
SSH Secure Shell Client 9 When this command is typed into the command prompt, the contents of the directory you are currently in will be displayed. It will also display permissions (more on permissions later). ls l This command displays all of the directory s contents, as well as file sizes, modification times, permissions and owners. pwd This doesn t necessarily list the contents of the directory, but it displays the pathname of your current directory starting from the root directory. Creating a File There are a number of ways to create a file. Text editors are used to create, edit, view, and save files. Vi is a very commonly used text editor. To create a file, in the command prompt, type in: vi [filename] The [filename] is whatever you want to name the file The type of file is up to the user. An extension is used to indicate the type of file. The format of the extension is as follows: [filename].[extension] The [extension] is typically a short abbreviation for the file type.
10 SSH Secure Shell Client Viewing a File There are several ways to view a file. A text editor allows you to view a file. The file must exist for this to work; otherwise this file will be created. Here s the format for viewing an existing file with vi: vi [filename] Another method of viewing a file is the cat command. This command will essentially um dump the contents of whatever file you want to see. Note that cat can only be used to view files and not to modify files. Here s the format for cat: cat [filename] Running Programs The general format for running a program from the command prompt is as follows: [progname] [param1] [param2] [progname] refers to the particular program you want to run. All of the parameters that follow it are necessary to the particular program. Here are a few examples: vi [filename] In this example the text editor vi is the program and [filename] is the parameter. This effectively states that vi will run the file with the filename. ls l In this example the ls command is considered the program and l is the parameter. This states that you would like to run ls with the condition of displaying more information about the contents of the directory.
SSH Secure Shell Client 11 Transferring Files Accessing Transfer Window The purpose of transferring files to/from your remote server is to preserve space on your home computer, and to provide accessibility to your files on any computer that has an SSH Secure Shell Client. There are several ways to open up the Transfer Files window: Along the toolbar, there is a folder icon labeled as New File Transfer Window. This will open up the SSH Secure File Transfer window, where the remote server s working directory will be the user s root directory. See image below: Another way of accessing the Secure File Transfer window, is to open up the Window menu and then choose New File Transfer. Like above, the remote server s working directory will be the user s root directory. It is also possible to open the Secure File Transfer window, such that the remote server s working directory is the current directory your command prompt is in. To access this feature, open the Window menu and choose New File Transfer in Current Directory. Getting accustomed to the Environment The file transfer environment has three distinct areas:
12 SSH Secure Shell Client Local Name This area contains the organization of your home computer s full structure. It contains all of the folders and files of your home computer. Remote Name This area contains the organization of the server s directory structure. Note that the current working directory is determined by how you opened up the transfer window (see above). Lastly, the Transfer/Queue area shows the progress of all uploads/downloads currently taking place. Much like in a Windows environment, accessing a folder moves down the directory.
SSH Secure Shell Client 13 Creating a New Directory The File Transfer program allows you to create new directories within your home computer (within the Local Name area). To create a new directory, click the new Folder icon along the Local Name toolbar. This will create a new directory within your current directory. Another way to create a new directory is to click the right mouse button and choose the New Folder option. This will also create a new directory within your current directory. Refreshing a Directory Refreshing a directory can be done in the Local Name area, and the Remote Name area. If any file transfers are made, or are currently being done, it is a wise option to refresh the directory to observer the current progress. To refresh either area (Local or Remote), click the Refresh Local icon on the toolbar of either area. Another way to refresh a directory is to click the right mouse button and choose the Refresh option. Deleting a Directory/File Note that this can only be done in the Local Name area (your own computer). Highlight the file/directory you would like to delete. In the toolbar under the Local Name area, click the red x icon. Another way to delete a file/directory is to right click on the particular file/ directory and choose the delete option. Defaulting to Home The SSH Secure File Transfer Window allows you to go back to your default directory for either the Local System or the Remote System. The home for your own computer will be the desktop and the home for the remote server will be your root directly of your account.
14 SSH Secure Shell Client In the toolbar for either area, there is a house icon that represents this option. This can also be done by right clicking the mouse button and choosing the Home option. Moving to the Previous Directory This can be done in either the Local or Remote System. It is an efficient way of navigating through directories. In the toolbar for either area, there is a folder with an arrow that represents this option. This can also be done by right clicking the mouse and choosing the Up option. Moving files from Local Name to Remote Name This process is known as uploading a file/directory to the remote server. There are several methods of achieving this. To upload a file/directory, first highlight what you would like to upload. Then click the up icon in the middle of the upper toolbar. This will upload the particular file into the current directory of the remote server. See image below: Another option is to right click on the file/directory you want to upload and choose the upload option. You can also click and drag the particular file/directory you would like to upload. Moving files from Remote Name to Local Name This process is known as downloading a file/directory to the local server. There are several methods of doing this.
SSH Secure Shell Client 15 To download a file/directory, highlight what you would like to download within the remote server. Then click the down icon in the middle of the upper toolbar. This will download into your current directory of your Local System. See image below: Another option is to right click on the file/directory you want to download and choose the download option. You can also click and drag the particular file/directory you would like to download. Understanding the File Transfer The Transfer/Queue area contains all the current uploads/downloads between your computer and the remote server. It is important to understand all the tabs in this section: Source File This tab contains the file name you are currently uploading/ downloading. Source Directory This tab contains the directory you are downloading from/ uploading to. Destination Directory This tab contains the directory you are downloading to/uploading from. Size This shows the size of the particular file being downloaded/uploaded. Status This shows the percentage done of the upload/download. Speed This shows the rate at which the upload/download is going at. It s typically measured in kilobytes per second. Time This shows the time remaining in the upload/download.
16 SSH Secure Shell Client
Using Text Editing and Creating Programs SSH Secure Shell Client 17 Opening Files Opening a file can either be considered creating a new file or opening an existing file. Regardless, the same command is used for both. Note that the text editor vi will be used to open files. This will all be done within the SSH Shell command prompt. Editing Files To open an existing file, the file must already exist. The command for this is as follows: vi [filename] To create a new file, the command is the same thing as above, but the file name used must not exist. Editing files can easily be done through vi. Note that there are two modes in vi: command mode or text mode. Text mode allows you to simply write whatever text you want. Under command mode, you can do such options as copying, pasting, various ways of deleting, various ways of inserting text, and many more similar options. The following commands (used only in command mode) illustrate a brief but effective way of using vi: Pressing the Esc key is the easiest way to get into command mode. a places the cursor ahead of the character you are currently at. Note that this automatically brings you into text mode. i places the cursor before the character you are currently at. Note that this automatically brings you into text mode. x deletes a character. Note that by indicating how many characters you would like to delete, before pressing x, will delete that amount of characters. r replaces the character you are currently at, with the character you type next. dd deletes the current line you are at. Note that by indicating how many lines you would like to delete, before pressing dd, will delete that many lines.
18 SSH Secure Shell Client 0 (zero) places the cursor to the start of the current line $ places the cursor to the end of the current line yy copies the current line into the buffer p places the line or lines in the buffer into the text after the current line :w this command acts as saving the file :q exits vi Understanding File Extensions for Programs There are a number of ways to build a program. The programming languages that will be discussed here are C, C++, and Java. The file extension for a C file is [filename].c The file extension for a C++ file is [filename].cpp The file extension for a java file is [filename].java Compiling Programs There are various ways to compile programs. The methods listed here are the most basic way to compile programs: For the C programming language: cc o [program] [filename].c Note that [program] will be the actual program to run For the C++ programming language: c++ o [program] [filename].cpp Note that [program] will be the actual program to run For the Java programming language: javac [filename].java
SSH Secure Shell Client 19 Running Programs To run a C program the compiled file, [program], will be the actual program. Follow the section on Running Programs, to see how to run the program. To run a C++ program the compiled file, [program], will be the actual program. Follow the section on Running Programs, to see how to run the program. Running a Java program is a little different. The Java Interpreter is what actually runs the Java program. Here s the syntax to run it: java [filename] Where filename is the compiled Java file.
20 SSH Secure Shell Client
SSH Secure Shell Client 21 Setting Permissions Understanding the Concept of Setting Permissions The primary purpose of permissions is to allow only certain types of people to have specific access of a file. This is important, for example, if you create a file on a server and only want to let other people read it but not write to it. Defining Permissions There are three types of groups involved in the setting of permissions: Owner The particular file s owner. Group This refers to anyone who belongs to a particular group of a particular file. Public Anybody who is not covered under Owner or Group. There are also three basic types of file permissions: Reading a File Writing to a File Executing a File These two different types of categories (user types and file permissions) essentially define setting permissions. A common way of defining a permission is by using an octal value. 0400 Read allowed by owner 0200 Write allowed by owner 0100 Owner can execute file 0040 Read allowed by group 0020 Write allowed by group
22 SSH Secure Shell Client 0020 Write allowed by group 0010 Group member can execute file 0004 Other types of user can read file 0002 Other types of user can write file 0001 Other types of user can execute file The addition of any of these values produces the full permission setting on a file. For example, the value 0764 means that the owner can read, write, and execute the particular file, the group can read and write to the file and anybody else can just read it. Another example, the value 0273 means that the owner can write to the file, the group can read, write, and execute the file, and anyone else can read and write to it. Viewing Permissions The command ls l views a directory s contents including the file permissions of each file. To the left of each file, there are 10 characters defining the permissions. The first character will be d if that file is a directory; otherwise if it s a - then it s actually a file. The second, third, and fourth characters represent the permissions for the owner. The second character will be r or - representing that the owner can either read the file or can t, respectively. The third character will be w or - representing that the owner can either write to the file or can t, respectively. The fourth character will be x or - representing that the owner can either execute the file or can t, respectively. The fifth, sixth, and seventh characters represent the permissions for the group. They are defined in the same manner as the second, third, and fourth characters except they apply to the group. The eighth, ninth, and tenth characters represent the permissions for anybody else. They are defined in the same manner as the second, third, and fourth characters except they apply to anybody else.
SSH Secure Shell Client 23 The following image shows an example directory listing: As an example, the file flyer.pdf, whose permissions are rw-r--r--, states that this file can be read by the owner, the group, and anybody else, can only be written to by the owner and nobody can execute. Setting a Permission to a File The user can alter the permissions of existing files, as long as the user is the owner of the file. The command for setting a permission is: chmod [number] [filename].[extension] [number] is the octal value described above. See the example above on how to set specific permissions.
24 SSH Secure Shell Client
SSH Secure Shell Client 25 Using Email Accessing your Email Account Depending on what comes with your account, you can have the accessibility of e- mail. This would primarily be an issue with the institution or the provider from which you are getting access. For further information on this, consult your school or provider. Within the SSH Secure Shell Client, the primary program for checking e- mail is Pine. To open up Pine, type pine in the command prompt. View image here: Getting to know Pine Pine is a command based e-mail program. Instead of clicking icons to do processes, the program has single character shortcuts. The program lists most of these shortcuts on the bottom of the screen. Though each task within Pine may use different commands, the bottom screen serves as a helpful guide. The program also includes other various help within its help menu. Like other e-mail services, Pine allows you to do a number of tasks including: Sending Email Reading Email Creating folders for Messages Setting up an Address Book Setting up Personal Settings *Note that when Pine shows /\, it is referring to the Ctrl key on the keyboard.
26 SSH Secure Shell Client Sending Email In your main menu, go to the Compose Message option or press the C key on your keyboard. This will bring you to the form for an e-mail. To: refers to whom the e-mail is being sent. Cc: this refers to any additional e-mail addresses to which you would like the letter. This is otherwise known as forwarding. Make sure to separate e-mail addresses by commas. Attachmnt: this is any file(s) that will be sent within the e-mail. Rather than typing the location by verbatim, you should use the attachment function Pine offers. This can be accessed by choosing the operation Ctrl+J. Subject: the purpose of the email. Message Text this will contain the body of the e-mail. Within the message text, you can change text styles, formats, and other text editing procedures.
SSH Secure Shell Client 27 Once all of the necessary fields are filled out, you are ready to send the e-mail. This can be done by choosing Ctrl+X. If there is any other option you would like to choose but do not see it on the bottom of the screen, choose Ctrl+G to get the Help Menu. Reading Email On the main menu, there is an option called Message Index. Either choose this option or choose I. Then highlight the e-mail you would like to read and hit enter. From there you can choose to read, reply to, or forward the e-mail. From the menu on the bottom you can do a number of things such as: read the next message, delete, and view attachments along with a number of other options. If there are any options not mentioned on the bottom you would like to get access to, choose?.
28 SSH Secure Shell Client Selecting a Mailbox Folder Pine gives you the option to choose one of the following folders directly: INBOX sent-mail saved-messages sent-mail-[last month]-[the year of last month] On the main menu screen, choose the Folder List or press the letter L. This will bring you to a screen which allows you to use the folder of your choice. From here you can do a number of options. If you want to choose a folder, you can highlight the particular folder and hit enter. This can also be done by using the keyboard shortcuts displayed on the bottom of the screen. You can also add ( a ) or delete a folder ( d ). As previously mentioned, if there are any other commands you would like to get access to, you can view the Help Menu (? ). Setting up your Address Book Like other e-mail services, Pine gives you the option of setting up an address book. The purpose is to look up someone s e-mail account without having to memorize their address and give you options to send e-mails more efficiently and quickly. Also, you can set up a list e-mail as well. On the main menu screen, highlight the Address Book option and press enter or press the A key. In this example, I will show you how to enter a person into your address book. In the address book screen, press @ (Shift+2). This will bring you to the Address Book Add screen. Enter in the following information (not all slots need to be filled): Nickname Name of list or a nickname for the person you are adding Fullname Names of person(s) who are being added Fcc I ll get back to you on that. Comment Any additional comments about the person(s) you are entering. Addresses The e-mail address of the person you are adding. If you are adding more than one e-mail address, separate addresses by commas.
SSH Secure Shell Client 29 Once the fields are filled out, press Ctrl +X to save the entry and exit out of the add screen. This will bring you back to the Address Book screen. If you would like to delete any names, highlight the desired name and press D. This command and many others can be found on the bottom of the screen. Setting up Personal Options On the main menu screen, highlight Setup or press S. This displays what you currently have for such helpful shortcuts as Exit Setup, Printer, Newpassword, Config, Signature, and many more. All these shortcuts are displayed on the bottom of the screen as well.
30 SSH Secure Shell Client Quitting Pine One shortcut that works continuously throughout each part of Pine is quitting the program. To quit Pine, press Q any time and the program will prompt you whether you want to close it. Press either Y for yes or N for No.
SSH Secure Shell Client 31 Glossary A Authentication Method A number of options that allow you to enter your password. These options are Password, Public Key, SecurID, PAM, Keyboard Interactive and <Profile Settings>. C Command Environment Type of computer environment where you operate by typing commands and shortcuts. A mouse is not used in this type of computer environment. D Directory Also known as a folder, contains either files or other directories. It is a helpful way to orgranize the contents of your computer. E E-mail (or Email) Known as Electronic Mail, is a process of sending letters/messages through the Internet. F File Transfer A process which involves moving contents from your home computer to your remote server. File Extensions A way for the computer to recognize the function of a file. H Host Name The name of the server from which you are getting access from. L Local Name Otherwise known as your Home Computer, contains files and programs on your home machine. N New File Transfer window Begins a new file transfer session within the current server you are working from. P Permissions A way of authorizing access to a file for yourself, groups, and the public.
32 SSH Secure Shell Client Pine The primary e-mail program used within a UNIX Shell. Port Number Location where a particular server may be located on. The traditional port number for the SSH Secure Shell is 22. Profiles A way to store server information without having to enter it again. Q Quick Connect The primary window to connect to a server. You do have the option to create a default information in this window. R Remote Host window The window that displays information from the current server you are working from. Unless specified, it will open from your root directory. Remote Name The label given to the server under the File Transfer Protocol part of the SSH Secure Shell. Remote Server Otherwise known as the server, contains the directories and files of the server. Root The default starting point on you server. S Secure File Transfer window The window that allows for you to transfer files between you Local and Remote systems. T Transfer/Queue area The area in the file transfer section that displays the progress of the transfer.. The following information is within this area: Source File, Source Directory, Destination Directory, Siz, Status, Speed, and Time. U User Name The name recognized by the server to allow you access. UNIX Programming Language used to operate an SSH Secure Shell Client. V vi One of the many text editor programs found within an SSH Secure Shell Client.
SSH Secure Shell Client 33 Index A Authentication Method 3, 4 C Command Environment 1, 7, 9, 10, 11, 17, 25 compiling Programs 18 creating a new Directory 13 D defining Permissions 21 deleting a Directory/File 13 Directories creating 8 viewing 8 E editing Files 17 e-mail sending 26-27 reading 27 address book 28 F file creating 9 viewing 10 File Extensions 18 File Transfer 11, 13, 15 Source File 15 Source Directory 15 Destination Directory 15 Size 15 Status 15 Speed 15 Time 15 H host name 1, 4 N navigating through Directories UNIX environment 8 File Transferring 14 New File Transfer Window 11 O opening Files 17 P Password screen 3 Permission Groups 21 Owner 21-22 Group 21-22 Public 21-22 Pine 25-26, 28; quitting 30 sending Email 25, 26 reading Email 25, 27 creating folders for Messages 25, 28 selecting a Mailbox Folder (see creating folders for Messages) setting up an Address Book 25, 28-29 setting up Personal Settings 25, 29 setting up Personal Options (see setting up Personal Settings) Port Number 1, 4 Profiles adding 4 editing 4-5 Q Quick Connect 2 S Secure File Transfer window 11, 13 setting Permissions 1, 21-23, to a file 22-23 T Transfer/Queue area 12, 15 Transfer Window 11, 12 Transferring Files 1, 11, 15 U User Name 2, 3, 4 UNIX 1, 7 V vi 7 for text editing 9, 17 to create a file 9 for viewing a file 10 running programs 10 open existing file 17 how to use 17 to exit 18 Viewing Permissions 22-23 L Local Name 13 moving files from Remote Name 14 M moving to the previous Directory 14 R refreshing a Directory 13 Remote Host window 2, 3 Remote Name 12, 13 moving Files from Local Name 14 Remote Server 11, 13, 14, 15 running Programs 10 programming 19