Skip to content

Commit b7c3786

Browse files
bios62bios62
committed
initial commit of the asset
1 parent 5c705ba commit b7c3786

36 files changed

+5729
-0
lines changed

‎security/security-design/shared-assets/bastion-py-script/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎security/security-design/shared-assets/bastion-py-script/README.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Bastion session
3+
4+
This reusable asset consist of a Python script that creates a bastion session with the Oracle OCI bastion service. The main purposes of this asset are:
5+
6+
- Demonstrate the usage of OCI Python SDK
7+
- Create a simple OS independent command-line interface for creating bastion sessions
8+
- Create a simple way to make reusable configuration
9+
- Create a `ssh` command that works with Linux, Mac OS and Windows by providing the flexibility to configure either `ssh` command or `putty` commands.
10+
11+
The script creates bastion session over SSH, and creates an example command to set up the tunnel for the target application. Other protocols like RDP can then be tunneled over the SSH session through the bastion service.
12+
13+
Some documentation for inspiraton:
14+
15+
[https://www.ateam-oracle.com/post/openssh-proxyjump-with-oci-bastion-service](https://www.ateam-oracle.com/post/openssh-proxyjump-with-oci-bastion-service)
16+
[https://fluffyclouds.blog/2022/06/02/create-oci-bastion-sessions-with-python-sdk/](https://fluffyclouds.blog/2022/06/02/create-oci-bastion-sessions-with-python-sdk/)
17+
18+
## Why use bastion service
19+
20+
Oracle Cloud Infrastructure (OCI) Bastion service, is a fully managed service providing secure and ephemeral Secure Shell (ssh) access to the private resources in OCI. OCI Bastion service, like the bastion fortress of medieval times, improves security posture by providing an additional layer of defense against external threats.
21+
22+
Accessing virtual services directly from the internet is a clear no-go. Best practices is to never expose compute resources directly, neither for SSH or RDP traffic. RDP is known to be one of the most common Initial Access Vectors for ransomware types of attacks.
23+
24+
Common practice is to place a compute node with a minimum OS in a DMZ as jump host, and always use this as the entrypoint.
25+
The main weakness with this model is:
26+
- A extra computer-node that needs to be managed, monitored and patched
27+
- Extra set of required resources with risk of misconfiguration
28+
- The jump server will require an additional layer of user governance.
29+
30+
The OCI Bastion service removes the public and private virtual cloud networking (VCN) hassle for access to a jump host. No public IP is needed, resulting in no surface attack area or zero-day vulnerabilities with a dedicated jump host. Customers also eliminate shared credentials, broad access limits, and other bad habits of using jump hosts. OCI Bastion service integrates with OCI Identity and Access Management (IAM) and allows the organization to control who can access a bastion or a session and what they can do with those resources.
31+
32+
The OCI Bastion service exists in two flavors:
33+
- Managed session
34+
With managed sessions an agent is running on the compute node, and the bastion session connects to the agent and tunnels SSH through the agent. The managed Session makes it possible to connect to a compute node from other networks without configure routing between the network where the compute node resides, and the network the bastion connection is initiated from.
35+
- Port Forwarding
36+
In this mode the bastion service does not tunnel though the agent, but the bastion service must have access to the subnet where the compute node resides, and the subnet security list
37+
For additional description of the bastion service please review:
38+
39+
## Requirements
40+
41+
The following components needs to be installed in your environment:
42+
- python 3.8 or above (latest patch version)
43+
- Latest version of the OCI CLI
44+
- Requirements, as defined in requirements.txt
45+
46+
If you need to ru older Python versions (below 3.8), note the changes for asyncio in the exec_command procedure.
47+
48+
[OCI CLI Install guide](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm)
49+
50+
The file requirements.txt lists the Python modules required.
51+
Install the required modules with
52+
53+
```pip install -r requirements.txt```
54+
55+
56+
## Script Usage
57+
58+
In addition, the script require a JSON configuration file.
59+
60+
The basic structure of the config file looks like:
61+
```
62+
{ "sessions":[
63+
{ <session one points to ociconfigurations>},
64+
{ <session two points to ociconfigurations>}],
65+
"ociconfigurations": [
66+
{ <ociconfiguration one>},
67+
{ <ociconfiguration one>}]
68+
}
69+
```
70+
For example, review [config_example.json](files/config_example.json)
71+
72+
The following elements exists in the configuration file.
73+
74+
- "sessions": JSON array with one JSON config entry pr. Session
75+
- "ociconfigurations": JSON Array with one JSON element pr. OCI SDK configuration profile.
76+
77+
Each “session” element has the following elements:
78+
- "sessionType":"PORT_FORWARDING" or MANAGED
79+
- "OCIConfig"-: name of profile, it looked up in the ociconfigurations array
80+
- "bastionOCID": OCID to the configured Bastion service
81+
- "bastionPublicKeyFile":file with public key to the Bastion SSH session
82+
- "bastionPrivateKeyFile":Private key of bastion session key pair,
83+
- "targetPrivateKeyFile":Used for reference in the target `ssh` command,
84+
- "targetPort": Portnumber for the target SSH tunnel though the bastions Service. Use standard port for RDP if target is RDP,
85+
- "localPort":"2222",
86+
- "sessionDisplayName": Display name of the session in the OCI Console
87+
- "targetOCIDID":OCID of the target service,
88+
- "targetPrivateIP":IP Address of the target
89+
- "osUserName": Used for the generated `ssh` command ,
90+
- "ociRegion": Region where the target resource runs,
91+
- "timetolive":Time the Bastion tunnel lives. Maximum value is 3600 sec.,
92+
- "maxWaitCount":If the script creates the tunnel after creation of the session, maximum number of retries
93+
- "waitRefresh": time in sec, between each retry to establish the tunnel
94+
- "ociconfigurations": Array of OCI configurations
95+
96+
Each array entry got the following JSON elements
97+
- "configName": Name of entry. Referenced from a session element above
98+
- "configFileName": Path to the OCI CLI configuration file
99+
- "profileName": Name of profile in the OCI CLI configuration file
100+
101+
102+
```Script commandline options.
103+
--configfile name of JSON configfile with named session and OCI CLI config info
104+
--session named session, section in config file
105+
--exec executes the `ssh` command and establishes the SSH connection
106+
--loglevel logging level, info or debug. default info
107+
--log logging output file or stdout, defaul stdout
108+
```
109+
Example command:
110+
111+
Example commandline:
112+
```python bastionsession.py --session port-example --configfile config_examlpe.json --loglevel debug```
113+
114+
Sample output
115+
116+
```
117+
Bastion session manager 1.0 17.11.24
118+
119+
INFO:root:Open logfile
120+
Open logfile: stderr
121+
Successfully loaded session and OCI Config parameters
122+
Waiting for session state to be active. Current State ..CREATING
123+
Session has been created and is ACTIVE
124+
Bastion session created
125+
Port managed start cmd
126+
Port forwarding start cmd
127+
ssh -i <privateKey> -N -L <localPort>:10.10.1.229:22 -p 22 ocid1.bastionsession.oc1.eu-frankfurt-1.ama...ama@host.bastion.eu-frankfurt-1.oci.oraclecloud.com
128+
ssh tunnel command:
129+
putty -i c:\\usr\\ssh_keys\\mykey.ppk -N -ssh -L 2222:10.10.1.229:22 ocid1.bastionsession.oc1.eu-frankfurt-1.ama...ama@host.bastion.eu-frankfurt-1.oci.oraclecloud.com
130+
Client Connect:
131+
putty -i c:\\usr\\ssh_keys\\myprivatetkey.ppk -P 2222 ios@localhost
132+
Successfully completed bastion session(s)
133+
```

‎security/security-design/shared-assets/bastion-py-script/files/__pycache__/constants.cpython-310.pyc

1.45 KB
Binary file not shown.

0 commit comments

Comments
 (0)