Teachers' Curriculum Institute

How do I generate SSH keys for automated CSV rostering?

OSX/ Linux

  • Step 1: Open a terminal window. Make sure you are logged in as admin/root user.
  • Step 2: Copy and paste this command without quotes into your terminal tab "ssh-keygen -t rsa -b 4096 -C "your_email@example.com"".

  • Step 4: You will be prompted to "Enter a file in which to save the key",  to accept the default location, press enter. You can also specify another path and file name.
  • Step 5: You will be prompted to “Enter a passphrase (empty if no password is desired)”. You can enter a passphrase, however, if you are using a script to connect and automate the rostering service, do NOT use a passphrase. Leave this blank and press enter.
  
 
  • Step 6: Please view the public key using the “cat” command and copy all the text inside that to a notepad. This is your SSH key to be used in the CSV Roster Integration setup.

 

Windows

  • Step 1: Download and install PuTTy .

  • Step 2: Once installed, open up PuTTygen.exe utility.

  • Step 3: Start the PuTTYgen utility

  • Step 4: For Type of key to generate, select SSH-2 RSA, in the Number of bits in a generated key field, specify 4096.

  • Step 5: Click the Generate button.

  • Step 6: Move your mouse pointer around in the blank area of the Key section, below the progress bar. Do this until the progress bar is full. This will add to the randomness of your key.
​​​​​​​​​​​​​​
  • Step 7:  A private/ public key pair has now been generated.
  • Step 8: In the Key comment field, please enter your administrators email address. If one cannot be provided enter the name of your school district.
  • Step 9 (Optional): Type a passphrase in the Key passphrase field & re-type the same passphrase in the Confirm passphrase field. For automation scripts, please do NOT enter a passphrase.
  • Step 10: Click on “Save private key” for later use. When prompted choose a secure location to save the file, and enter filename. For example, SchoolName_private.
  • Step 11: Click on “Save public key” for future reference. When prompted choose a secure location to save the file, and enter filename. For example, SchoolName_public.  
  • Step 12: Right-click in the text field labeled “Public key for pasting into OpenSSH authorized_keys file” and choose Select All. See screenshot. 
 
 
  • Step 13: Right-click again in the same text field and choose Copy. This is your SSH key to be used in the CSV Roster Integration setup.​​​​​​​


Note: PuTTY and OpenSSH use different formats for public SSH keys. If the SSH Public Key you copied starts with "---- BEGIN SSH2 PUBLIC KEY ...", it is in the wrong format. Be sure to follow the instructions carefully. Your public key that you send to TCI should start with "ssh-rsa AAAA ...."

Did you find this article helpful?