Skip to Content

Changes for page SFTP Security

Last modified by Danniar Firdausy on 2024/09/18 20:33
From version 25.9
edited by Danniar Firdausy
on 2024/09/18 20:33
Change comment: There is no comment for this version
To version 16.1
edited by eMagiz
on 2022/05/17 09:29
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -SFTP Security
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.marijn
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,9 +1,20 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
1 +{{html wiki="true"}}
2 +<div class="ez-academy">
3 + <div class="ez-academy_body">
2 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.
5 +<div class="doc">
4 4  
5 -Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
8 +
9 += SFTP Security =
10 +
11 +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.
12 +
13 +Should you have any questions, please get in touch with academy@emagiz.com.
14 +
15 +* Last update: August 25th, 2021
16 +* Required reading time: 9 minutes
17 +
7 7  == 1. Prerequisites ==
8 8  
9 9  * Basic knowledge of the eMagiz platform
... ... @@ -12,8 +12,16 @@
12 12  == 2. Key concepts ==
13 13  
14 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 16  
27 +By SFTP security, we mean: Making sure that the SFTP we connect to knows that we are indeed eMagiz
28 +
29 +* Private key is unique per client
30 +* Private key should only be known to the client
31 +* Public key should be known to the SFTP (server), so they trust us when we set up the communication
32 +* A private key comes with a passphrase
33 +
34 +
35 +
17 17  == 3. SFTP Security ==
18 18  
19 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.
... ... @@ -23,11 +23,11 @@
23 23  * Public key should be known to the SFTP (server), so they trust us when we set up the communication
24 24  * A private key comes with a passphrase
25 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"]].
45 +If you are looking for some introductory reading into certificates, please check this [microlearning](novice-securing-your-data-traffic-what-are-certificates.md).
27 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.
47 +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, I will not explain 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 29  
30 -[[image:Main.Images.Microlearning.WebHome@intermediate-file-based-connectivity-sftp-security--private-key-config.png]]
49 +<p align="center">[[image:intermediate-file-based-connectivity-sftp-security--private-key-config.png||]]</p>
31 31  
32 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 33  
... ... @@ -35,23 +35,37 @@
35 35  
36 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 37  
38 -== 4. Key takeaways ==
57 +===== Practice =====
39 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.
59 +== 4. Assignment ==
44 44  
45 -== 5. Suggested Additional Readings ==
61 +Check within your project(s) whether an SFTP connection is secured with the help of private key construction.
62 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
46 46  
64 +== 5. Key takeaways ==
65 +
66 +* Private key is unique per client
67 +* Private key should only be known to the client
68 +* Public key should be known to the SFTP (server), so they trust us when we set up the communication
69 +* A private key comes with a passphrase
70 +
71 +
72 +
73 +== 6. Suggested Additional Readings ==
74 +
47 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 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"]]
77 +* https://docs.spring.io/spring-integration/docs/2.2.6.RELEASE/reference/html/sftp.html#sftp-outbound
78 +* https://docs.spring.io/spring-integration/docs/2.2.6.RELEASE/reference/html/sftp.html#sftp-session-factory
79 +* https://www.2brightsparks.com/resources/articles/sftp-authentication.html
56 56  
57 -)))((({{toc/}}))){{/container}}{{/container}}
81 +== 7. Silent demonstration video ==
82 +
83 +As this is a more theoretical microlearning, there is no video.
84 +
85 +</div>
86 +
87 +</div>
88 +</div>
89 +
90 +{{/html}}