forked from aws-samples/hardeneks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
338 lines (294 loc) · 15.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>hardeneks API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Package <code>hardeneks</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from pathlib import Path
from pkg_resources import resource_filename
import yaml
from botocore.exceptions import EndpointConnectionError
import boto3
import kubernetes
from rich.console import Console
import typer
from .resources import (
NamespacedResources,
Resources,
)
from .harden import harden
app = typer.Typer()
def _config_callback(value: str):
config = Path(value)
if config.is_dir():
raise typer.BadParameter(f"{config} is a directory")
elif not config.exists():
raise typer.BadParameter(f"{config} doesn't exist")
with open(value, "r") as f:
try:
yaml.load(f, Loader=yaml.FullLoader)
except yaml.YAMLError as exc:
raise typer.BadParameter(exc)
return value
def _get_current_context(context):
if context:
return context
_, active_context = kubernetes.config.list_kube_config_contexts()
return active_context["name"]
def _get_namespaces(ignored_ns: list) -> list:
v1 = kubernetes.client.CoreV1Api()
namespaces = [i.metadata.name for i in v1.list_namespace().items]
return list(set(namespaces) - set(ignored_ns))
def _get_cluster_name(context, region):
try:
client = boto3.client("eks", region_name=region)
for name in client.list_clusters()["clusters"]:
if name in context:
return name
except EndpointConnectionError:
raise ValueError(f"{region} seems like a bad region name")
def _get_region():
return boto3.session.Session().region_name
@app.command()
def run_hardeneks(
region: str = typer.Option(
default=None, help="AWS region of the cluster. Ex: us-east-1"
),
context: str = typer.Option(
default=None,
help="K8s context.",
),
cluster: str = typer.Option(default=None, help="Cluster name."),
namespace: str = typer.Option(
default=None,
help="Specific namespace to harden. Default is all namespaces.",
),
config: str = typer.Option(
default=resource_filename(__name__, "config.yaml"),
callback=_config_callback,
help="Path to a hardeneks config file.",
),
):
"""
Main entry point to hardeneks.
Args:
region (str): AWS region of the cluster. Ex: us-east-1
context (str): K8s context
cluster (str): Cluster name
namespace (str): Specific namespace to be checked
config (str): Path to hardeneks config file
Returns:
None
"""
kubernetes.config.load_kube_config(context=context)
context = _get_current_context(context)
if not cluster:
cluster = _get_cluster_name(context, region)
if not region:
region = _get_region()
console = Console()
console.rule("[b]HARDENEKS", characters="* ")
console.print(f"You are operating at {region}")
console.print(f"You context is {context}")
console.print(f"Your cluster name is {cluster}")
console.print(f"You are using {config} as your config file")
console.print()
with open(config, "r") as f:
config = yaml.load(f, Loader=yaml.FullLoader)
if not namespace:
namespaces = _get_namespaces(config["ignore-namespaces"])
else:
namespaces = [namespace]
rules = config["rules"]
console.rule("[b]Checking cluster wide rules", characters="- ")
print()
resources = Resources(region, context, cluster, namespaces)
resources.set_resources()
harden(resources, rules, "cluster_wide")
for ns in namespaces:
console.rule(
f"[b]Checking rules against namespace: {ns}", characters=" -"
)
console.print()
resources = NamespacedResources(region, context, cluster, ns)
resources.set_resources()
harden(resources, rules, "namespace_based")
console.print()</code></pre>
</details>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="hardeneks.cluster_wide" href="cluster_wide/index.html">hardeneks.cluster_wide</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="hardeneks.harden" href="harden.html">hardeneks.harden</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="hardeneks.namespace_based" href="namespace_based/index.html">hardeneks.namespace_based</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="hardeneks.report" href="report.html">hardeneks.report</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="hardeneks.resources" href="resources.html">hardeneks.resources</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="hardeneks.run_hardeneks"><code class="name flex">
<span>def <span class="ident">run_hardeneks</span></span>(<span>region: str = <typer.models.OptionInfo object>, context: str = <typer.models.OptionInfo object>, cluster: str = <typer.models.OptionInfo object>, namespace: str = <typer.models.OptionInfo object>, config: str = <typer.models.OptionInfo object>)</span>
</code></dt>
<dd>
<div class="desc"><p>Main entry point to hardeneks.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>region</code></strong> : <code>str</code></dt>
<dd>AWS region of the cluster. Ex: us-east-1</dd>
<dt><strong><code>context</code></strong> : <code>str</code></dt>
<dd>K8s context</dd>
<dt><strong><code>cluster</code></strong> : <code>str</code></dt>
<dd>Cluster name</dd>
<dt><strong><code>namespace</code></strong> : <code>str</code></dt>
<dd>Specific namespace to be checked</dd>
<dt><strong><code>config</code></strong> : <code>str</code></dt>
<dd>Path to hardeneks config file</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>None</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@app.command()
def run_hardeneks(
region: str = typer.Option(
default=None, help="AWS region of the cluster. Ex: us-east-1"
),
context: str = typer.Option(
default=None,
help="K8s context.",
),
cluster: str = typer.Option(default=None, help="Cluster name."),
namespace: str = typer.Option(
default=None,
help="Specific namespace to harden. Default is all namespaces.",
),
config: str = typer.Option(
default=resource_filename(__name__, "config.yaml"),
callback=_config_callback,
help="Path to a hardeneks config file.",
),
):
"""
Main entry point to hardeneks.
Args:
region (str): AWS region of the cluster. Ex: us-east-1
context (str): K8s context
cluster (str): Cluster name
namespace (str): Specific namespace to be checked
config (str): Path to hardeneks config file
Returns:
None
"""
kubernetes.config.load_kube_config(context=context)
context = _get_current_context(context)
if not cluster:
cluster = _get_cluster_name(context, region)
if not region:
region = _get_region()
console = Console()
console.rule("[b]HARDENEKS", characters="* ")
console.print(f"You are operating at {region}")
console.print(f"You context is {context}")
console.print(f"Your cluster name is {cluster}")
console.print(f"You are using {config} as your config file")
console.print()
with open(config, "r") as f:
config = yaml.load(f, Loader=yaml.FullLoader)
if not namespace:
namespaces = _get_namespaces(config["ignore-namespaces"])
else:
namespaces = [namespace]
rules = config["rules"]
console.rule("[b]Checking cluster wide rules", characters="- ")
print()
resources = Resources(region, context, cluster, namespaces)
resources.set_resources()
harden(resources, rules, "cluster_wide")
for ns in namespaces:
console.rule(
f"[b]Checking rules against namespace: {ns}", characters=" -"
)
console.print()
resources = NamespacedResources(region, context, cluster, ns)
resources.set_resources()
harden(resources, rules, "namespace_based")
console.print()</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="hardeneks.cluster_wide" href="cluster_wide/index.html">hardeneks.cluster_wide</a></code></li>
<li><code><a title="hardeneks.harden" href="harden.html">hardeneks.harden</a></code></li>
<li><code><a title="hardeneks.namespace_based" href="namespace_based/index.html">hardeneks.namespace_based</a></code></li>
<li><code><a title="hardeneks.report" href="report.html">hardeneks.report</a></code></li>
<li><code><a title="hardeneks.resources" href="resources.html">hardeneks.resources</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="hardeneks.run_hardeneks" href="#hardeneks.run_hardeneks">run_hardeneks</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>