PATH: System Administration > Data Utilities > Data Extract Utility SFTP Key Exchange Manager
Search Term: Data Extract Utility SFTP Key Exchange Manager
The Data Extract Utility SFTP Key Exchange Manager allows SFTP configurations within the Data Extract Utility to utilize a keypair between Infinite Campus and a third-party server(s) to bolster security for the data transferring process. Users can either generate an Infinite Campus key to be shared with a third-party system or download the third party's key into Infinite Campus.
Prerequisites
In order to use established SFTP keys, an extract within the Data Extract Utility must be configured to use a Delivery Mode of SFTP.
Tool Rights
Users should have full tool rights (RWAD) to the Data Extract Utility SFTP Key Exchange Manager in order to properly access and use its functionality. Tool rights for this tool should only be granted to system administrators.
Create and Connect an Infinite Campus-Generated SFTP Key
To create an Infinite Campus-generated key to be shared with your third-party system (server):
- Click the New button. The SFTP Key Exchange Configuration editor will appear.
- Enter a Name for the key. We recommend picking a name you can easily identify and differentiate from other keys.
- Click Save. If the key was successfully generated, a green notification box will appear, indicating the configuration was saved successfully (see image above).
- A Key Management Options section is now available. Click the Download Client SFTP Public Key button and save the key to your local hard drive or network.
- Once the key (.pub file) is downloaded, open it within a text editor (or compatible program) and copy the entire key (see below for example).
- Paste this key within your external system/server where you store your other authentication keys and save.
- Once this Infinite Campus-generated key has been successfully added to and saved in your system's/server's key store, you can now configure a new extract using the SFPT protocol with an SSH key within the Data Extract Utility or modify an existing extract to begin using the SFPT protocol with an SSH key.
To utilize this new key for an existing or new Data Extract Utility configuration, select the SFTP Delivery Mode, mark the SFTP Key Exchange checkbox, and select the key you just set up in the SFTP Key Exchange Configuration dropdown list (see the image below for an example). Once these are selected, you should select the Test Connection button to test and make sure the connection between Infinite Campus and your system is authenticating correctly. If tested and working correctly, click the Save icon.
Import a Third-Party SFTP Key
If you have a copy of your server/system's SSH key (.pub file), you can use this to create a keypair between it and Infinite Campus for use in setting up an extract within the Data Extract Utility.
To import a third-party SFTP Key:
- Click the New button. The SFTP Key Exchange Configuration editor will appear.
- Enter a Name for the key. We recommend picking a name you can easily identify and differentiate from other keys.
- Click the Select Files button and select the key file (.pub file) from your local hard drive or network. NOTE: The key MUST be a .pub file
- Once the key has been selected, it will upload into Infinite Campus and appear below the Select File button (for example, see image below).
- Click the Save button. The key is now successfully imported and saved into Infinite Campus and can now be utilized when configuring Data Extract Utility extracts using the SFPT protocol.
To utilize this new key for an existing or new Data Extract Utility configuration, select the SFTP Delivery Mode, mark the SFTP Key Exchange checkbox, and select the key you just set up in the SFTP Key Exchange Configuration dropdown list (see the image below for an example). Once these are selected, you should select the Test Connection button to test and make sure the connection between Infinite Campus and your system is authenticating correctly. If tested and working correctly, click the Save icon.
Manage SFTP Keys
The Key Management Options section allows you to do the following:
| Refresh the Client SFTP Keypair | This is useful if you have just deleted an old key and uploaded a new key and need to refresh and restore the connection between Infinite Campus and your system. |
| Download Client SFTP Public Key | This is useful if you need access to an Infinite Campus SSH key. |
| Delete Server SFTP Public Key | This is useful for deleting an expired or incorrect key. Often this option will work in conjunction with the Refresh Client SFTP Keypair option where a user would first delete an old key, upload a new key and then refresh and repair the connection between Infinite Campus and your system. |
