Wiki source code of SFTP Security
Last modified by Danniar Firdausy on 2024/09/18 20:33
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{container}}{{container layoutStyle="columns"}}((( | ||
| 2 | |||
| 3 | In this microlearning, we will build on our previous discussion about connecting to SFTP from eMagiz by diving into a more advanced security configuration: private key setup. We will explore how to use private keys to ensure secure and trusted communication with SFTP servers. | ||
| 4 | |||
| 5 | Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]]. | ||
| 6 | |||
| 7 | == 1. Prerequisites == | ||
| 8 | |||
| 9 | * Basic knowledge of the eMagiz platform | ||
| 10 | * Novice course on File-based connectivity | ||
| 11 | |||
| 12 | == 2. Key concepts == | ||
| 13 | |||
| 14 | This microlearning is about SFTP security. | ||
| 15 | * By SFTP security, we mean: Making sure that the SFTP we connect knows that we are indeed eMagiz. | ||
| 16 | |||
| 17 | == 3. SFTP Security == | ||
| 18 | |||
| 19 | In the last microlearning, we discussed how to connect to an SFTP from eMagiz. In this microlearning, we want to expand our knowledge and look at a more complex security configuration when connecting to SFTP instances. The configuration we are talking about is the private key configuration. | ||
| 20 | |||
| 21 | * Private key is unique per client | ||
| 22 | * Private key should only be known to the client | ||
| 23 | * Public key should be known to the SFTP (server), so they trust us when we set up the communication | ||
| 24 | * A private key comes with a passphrase | ||
| 25 | |||
| 26 | If you are looking for some introductory reading into certificates, please check this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Novice.Securing Data Traffic.novice-securing-your-data-traffic-what-are-certificates.WebHome||target="blank"]]. | ||
| 27 | |||
| 28 | As the private key is yours, you can ask a trusted party to generate the key, or you could create it yourself. The latter part happens a lot when connecting to an SFTP. You could use a tool like PuttyGen to achieve this. As a result, you will have a keypair. The private key should be kept safely with you in eMagiz, and you need to share the public key with the SFTP server party. In this microlearning, we will not explore on how PuttyGen works in detail. Instead, we will focus on the part in eMagiz. In eMagiz, we need to refer to the key file (linked under Resources), and we need to refer to the password we use to save our key file securely. | ||
| 29 | |||
| 30 | [[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-sftp-security--private-key-config.png]] | ||
| 31 | |||
| 32 | Note that the use of a password and a private key are mutually exclusive. So you need to either provide a password or a private key for authentication. In the help text provided by eMagiz, you can see how the reference to the key file should be made. | ||
| 33 | |||
| 34 | When you have configured these settings, you have finished the configuration in eMagiz. Now you could test whether the configuration is set up correctly between eMagiz and the SFTP. If this is not the case, eMagiz will notify you via the Manage phase, either as an error message or a log entry. | ||
| 35 | |||
| 36 | Using this setting gives the server the option to verify if the communication request came from eMagiz (or at least from the party that holds the private key of eMagiz). This is an additional security measure to ensure data integrity and quality. | ||
| 37 | |||
| 38 | == 4. Key takeaways == | ||
| 39 | |||
| 40 | * Each client should have a unique private key. | ||
| 41 | * The private key must be kept secret and known only to the client. | ||
| 42 | * The public key can be shared with the SFTP server so it can authenticate your connection. | ||
| 43 | * The private key is protected by a passphrase to enhance security. | ||
| 44 | |||
| 45 | == 5. Suggested Additional Readings == | ||
| 46 | |||
| 47 | If you are interested in this topic and want more information, please read the release notes provided by eMagiz. Furthermore, check out these links: | ||
| 48 | |||
| 49 | * [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]] | ||
| 50 | ** [[Securing Data Traffic (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Securing Data Traffic.WebHome||target="blank"]] | ||
| 51 | *** [[What are certificates (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Securing Data Traffic.novice-securing-your-data-traffic-what-are-certificates.WebHome||target="blank"]] | ||
| 52 | * [[SFTP (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22sftp%22||target="blank"]] | ||
| 53 | * [[SFTP Authentication (External)>>https://www.2brightsparks.com/resources/articles/sftp-authentication.html||target="blank"]] | ||
| 54 | * [[SFTP Outbound (External)>>https://docs.spring.io/spring-integration/docs/2.2.6.RELEASE/reference/html/sftp.html#sftp-outbound||target="blank"]] | ||
| 55 | * [[SFTP Session Factory (External)>>https://docs.spring.io/spring-integration/docs/2.2.6.RELEASE/reference/html/sftp.html#sftp-session-factory||target="blank"]] | ||
| 56 | |||
| 57 | )))((({{toc/}}))){{/container}}{{/container}} |