Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit c175708

Browse files
committed
Added a general docs folder for all documentation stuff
1 parent 706b4ad commit c175708

File tree

12 files changed

+102
-1
lines changed

12 files changed

+102
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ kubectl get scans
129129

130130
## Architecture
131131

132-
![secureCodeBox Architecture](scb-architecture.svg)
132+
![secureCodeBox Architecture](./docs/resources/scb-architecture.svg)
133133

134134
## License
135135

docs/.gitkeep

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-minimal

docs/developer-guide/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Extending secureCodeBox
2+
3+
## Developing the SCB Operator
4+
5+
## How to a new security scanner
6+
7+
### ScanType Definition
8+
9+
### Parsing SDK
10+
11+
## How to integrate a new hook
12+
13+
### HookType Definition
14+
15+
### Hook SDK
16+
17+
# Guidelines
18+
## Coding Guidelines
19+
20+
### JSON
21+
We're using snake_case (lower case) for json attributes. If an enum type is used as attribute its converted to lower case. If it's an value it's always used UPPERCASE. This is to hold the attribute api consistent, but make shure Enums are recognized as enums.
22+
23+
```json
24+
{
25+
"id": "e18cdc5e-6b49-4346-b623-28a4e878e154",
26+
"name": "Open mysql Port",
27+
"description": "Port 3306 is open using tcp protocol.",
28+
"category": "Open Port",
29+
"osi_layer": "NETWORK",
30+
"severity": "INFORMATIONAL",
31+
"attributes": {
32+
"protocol": "tcp",
33+
"port": 3306,
34+
"service": "mysql",
35+
"mac_address": null,
36+
"start": "1520606104",
37+
"end": "1520606118",
38+
"ip_address": "127.0.0.1",
39+
"state": "open"
40+
},
41+
"location": "tcp://127.0.0.1:3306"
42+
}
43+
```

docs/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Continuous Secure Delivery - Out of the Box
2+
3+
![secureCodeBox](resources/logo.png "secureCodeBox")
4+
5+
> _secureCodeBox_ is a docker based, modularized toolchain for continuous security scans of your software project.
6+
7+
## Documentation Overview
8+
9+
<!-- toc -->
10+
- [Project Readme and Quickstart][scb-github]
11+
- [User Guide](user-guide/README.md)
12+
- [Developer Guide](developer-guide/README.md)
13+
14+
<!-- tocstop -->
15+
16+
## Need a human?
17+
- [Join Slack][scb-slack]
18+
19+
## License
20+
Code of secureCodeBox is licensed under the [Apache License 2.0][scb-license].
21+
22+
[scb-github]: https://github.com/secureCodeBox/secureCodeBox
23+
[scb-twitter]: https://twitter.com/secureCodeBox
24+
[scb-slack]: https://join.slack.com/t/securecodebox/shared_invite/enQtNDU3MTUyOTM0NTMwLTBjOWRjNjVkNGEyMjQ0ZGMyNDdlYTQxYWQ4MzNiNGY3MDMxNThkZjJmMzY2NDRhMTk3ZWM3OWFkYmY1YzUxNTU
25+
[scb-license]: https://github.com/secureCodeBox/secureCodeBox/blob/master/LICENSE

docs/resources/logo.png

21.8 KB
Loading

docs/resources/logo.svg

Lines changed: 28 additions & 0 deletions
Loading

docs/resources/macbook_kibana.jpg

329 KB
Loading

0 commit comments

Comments
 (0)