Skip to content

Commit 94df39d

Browse files
AOrpsAOrps
committed
Contribution Guide and Writeups fleshed out
1 parent 9ae40a3 commit 94df39d

File tree

5 files changed

+141
-42
lines changed

5 files changed

+141
-42
lines changed

‎.github/contributing.md

+53-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Contributing
22

3-
* Your one stop shot in
3+
* Your one stop spot for Contributing!
4+
45
---
56
## How to Contribute
67

@@ -34,9 +35,60 @@
3435
| [web/README.md](web/README.md)
3536

3637
### Creating a writeup for a challenge
38+
* *Helping both Beginners and More Seasoned Github Users*
39+
---
40+
#### For Github Beginners
41+
1. **Fork** github repository
42+
![](https://assets.digitalocean.com/articles/eng_python/PullRequest/GitHub_Repo.gif)
43+
1. _**(In a terminal)**_ **Clone** forked repository and move to cloned Directory
44+
* `git clone https://github.com/<your-username>/ctf-challenges.git`
45+
* `cd ctf-challenges`
46+
1. **Create** and **Switch** to new branch
47+
* `git checkout -b <branch name>` <!--`git checkout -b` is actually based-->
48+
* Preferably `<branch name>` is name challenge(s)
49+
1. Change Directory into writeups and into challenge that you have / want to make a write-up for
50+
* `cd writeups/<challenge>`
51+
1. Run `python3 ../../createWriteup.py <Name/Handle>`
52+
* This will create a structure that looks like this:
53+
```txt
54+
+--- <challenge: dir>
55+
| \--- <name/handle: dir>
56+
| \--- <solution: dir>
57+
| +--- README.md
58+
```
59+
1. Put all custom files / scripts that helped with the answering of the problem in the `<solution>` directory. Basically anything necessary goes in solution
60+
1. Document your method in the `README.md` file which is located in the `<challenge>/<name/handle>` directory
61+
1. Change Directory until you are at `ctf-challegnges/writeups`
62+
1. Git Add Files
63+
* `git add .`
64+
1. Git Commit
65+
* `git commit -m "<Describe edits / commit>"`
66+
1. Git Push
67+
* `git push origin <branch name>`
68+
1. With everything pushed onto Github, [follow this last tutorial](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) and you should be on your way!
69+
70+
---
3771
72+
### For More Experienced Github Frequenters
73+
1. Create a fork of Github repo, and
74+
1. Change directory into `writeups/<challenge>`, with `<challenge>` being the challenge the writeup is written for
75+
1. Run `python3 ../../createWriteup.py <Name/Handle>`
76+
* This will standardized the writeups in the repository
77+
1. Dump any scripts/file in `<solution>` directory located in `writeups/<challenge>/<Name/Handle>/<solution>` and describe Method in `writeups/<challenge>/<Name/Handle>/README.md`
78+
1. Create a PR Request from
79+
* _Note_: Organizers may request edits on your PR
80+
1. Wait and Drink Campagne during the Code Review process (if you are of the legal age)
81+
* _Note_: Will probably only check if the proper steps have been taken to create the writeup
3882
3983
84+
* DM / PM any of the organizers to help with the writeup process
85+
86+
---
87+
## Resources
88+
* [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
89+
* [DigitalOcean - How to create a Pull Request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github)
90+
* [Github Docs - Creating a Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
91+
* [Generate ASCII Tree Structures](https://cmatskas.com/generate-ascii-folder-structures-for-windows-with-tree/)
4092
4193
---
4294
## Last Resort

‎README.md

-3
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,13 @@ Development and Creation of CTF Challenges for JerseyCTF 2021
1717
| [pwn](pwn) | Reversing, binary exploitation
1818
| [web](web) | All types of web exploitation
1919

20-
2120
### Resources / Write-ups / Sponker Flags
2221
| Directory <!-- --> | Description<!-- This could have been a challenge -->
2322
| :--: | :--:
2423
| [sponker](sponker) | Sponsor and Speaker Flags
2524
| [writeups](writeups) | Writeups from participants
2625
| [resources](resources) | Resources from Tech Talks (i.e. Records, Literature, etc)
2726

28-
29-
3027
---
3128
## Interested in Contributing?
3229
* Check out [contributing.md](.github/contributing.md)

‎createWriteup.py

+16-17
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
"""
22
filename: createWriteup.py
33
Purpose: (Standardizaiton) To automate the process of creating a write-up
4-
Usage: python3 createWriteup.py <Name/Handle>
4+
Usage: python3 createWriteup.py <NameHandle>
55
Return(s):
6-
./<Name/Handle>
7-
./<ChallengeName>/challenge
8-
./<ChallengeName>/solution
9-
./<ChallengeName>/README.md
10-
--> # <ChallengeName>
6+
./<NameHandle>
7+
./<NameHandle>/solution
8+
./<NameHandle>/README.md
9+
--> # <NameHandle>
1110
"""
1211

1312
import sys
@@ -16,33 +15,33 @@
1615
def usage():
1716
print(f"Be sure to have your name / handle!")
1817
print(f"Usage:")
19-
print(f"python3 createWriteup.py <Name/Handle>")
18+
print(f"python3 createWriteup.py <NameHandle>")
2019

2120

2221
# Quick Function to make a file
2322
makeFile = lambda file: open(file, "x")
2423

2524
# main -> Returns a standardized process for a single challenge
26-
def main(challenge_name):
27-
README = f"{challenge_name}/README.md"
25+
def main(name_handle):
26+
README = f"{name_handle}/README.md"
2827

29-
# Creates `./<ChallengeName>`
30-
os.mkdir(f"{challenge_name}")
28+
# Creates `./<NameHandle>`
29+
os.mkdir(f"{name_handle}")
3130

32-
# Creates `./<ChallengeName>/challenge`
33-
os.mkdir(f"{challenge_name}/challenge")
31+
# Creates `./<NameHandle>/solution`
32+
os.mkdir(f"{name_handle}/solution")
3433

35-
# Creates `./<ChallengeName>/README.md`
34+
# Creates `./<NameHandle>/README.md`
3635
makeFile(f"{README}")
3736

3837
with open(f"{README}", "r+") as f:
39-
f.write(f"# {challenge_name}\n")
38+
f.write(f"# {name_handle}'s Write-up for (INSERT CHALLENGE NAME)\n")
4039

4140

4241
# Ensures that users are using the program correctly
4342
if __name__ == "__main__":
4443
try:
45-
challenge_name = sys.argv[1]
46-
main(challenge_name)
44+
name_handle = sys.argv[1]
45+
main(name_handle)
4746
except:
4847
usage()

‎pwn/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# PWN
2+
* In future, make crackme.
23

34
## Easy Challenges
45
| Challenge Name | Description | Hint

‎writeups/README.md

+71-21
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,98 @@
11
# Write-ups
2+
* This is a place that one can input their solutions to solving a challenge!
23

3-
## Write-up Sites
4+
---
45

6+
## To Contribute
7+
* Check out [Contribution Guide](../.github/contributing.md)
58

6-
##
9+
---
710

11+
## Sites
12+
<!-- Where anyone with websites will have the ctf -->
13+
| name/handle | URL | description
14+
| :--- | :--: | ---:
15+
| | |
16+
17+
---
18+
## Contributor write
19+
<!-- Standardization write-up section-->
820
### Crypto
921
* [Crypto](../crypto)
1022

1123
| Challenge | Write-ups
1224
| :----: | :----
13-
| [BlaiseDeCVE](../crypto/BlaiseDeCVE) | You'll need this CVE-2014-6271 to find the key!
14-
| [HideInside](../crypto/HideInside)| Don't see any flag flying in this city pic, must be hidden behind the scenes
15-
| [rail-fence](../crypto/rail-fence) | The flag is there but not. There must be some type of pattern. This flag needs to be submitted in upper case.
16-
| [rome](../crypto/rome)| "Rome Cryptography"
17-
| [rome-but-harder](../crypto/rome-but-harder) | Old Time Crypto with a Modern Spin
18-
| [StegAESaurus](../crypto/StegAESaurus) | Put all the key pieces together to crack this ciphertext
19-
| [Transformation](../crypto/Transformation)| Do you have an affinity for math? Then you’ll easily crack this cipher!
20-
| [XORED-Message](../crypto/XORED-Message) | There is some encrypted message, it apparently has something to do with logic.
25+
| [BlaiseDeCVE](../crypto/BlaiseDeCVE) | [write-ups](BlaiseDeCVE)
26+
| [HideInside](../crypto/HideInside)| [write-ups](HideInside)
27+
| [rail-fence](../crypto/rail-fence) | [write-ups](rail-fence)
28+
| [rome](../crypto/rome)| [write-ups](rome)
29+
| [rome-but-harder](../crypto/rome-but-harder) | [write-ups](rome-but-harder)
30+
| [StegAESaurus](../crypto/StegAESaurus) | [write-ups](StegAESaurus)
31+
| [Transformation](../crypto/Transformation)| [write-ups](Transformation)
32+
| [XORED-Message](../crypto/XORED-Message) | [write-ups](XORED-Message)
33+
34+
<!-- BlaiseDeCVE, HideInside, rail-fence, rome, rome-but-harder, StegAESaurus, Transformation, XORED-Message -->
2135

2236
### Forensics
2337
* [Forensics](../forensics)
38+
2439
| Challenge | Write-up
2540
| :--: | :--
26-
| [alternate-reality](../forensics/alternate-reality) | Find the flag in this forensic disk image.
27-
| [closed-creds](../forensics/closed-creds) | Using the registry files provided, what is the password of the Administrator user?
28-
| [data-about-data](../forensics/data-about-data) | Find the flag in this zip archive.
29-
| [file-desc](../forensics/file-desc) | What type of file is this?
30-
| [HASH-browns](../forensics/HASH-browns) | Get the decimal sum of the last 4 digits of all each file from an hash. They were talking about something pertains to md as the hash.
31-
| [investigating-windows](../forensics/investigating-windows) | Find the SID of the user robbr using the Windows registry files provided.
32-
| [pw-backup](../forensics/pw-backup) | I seem to not be getting the full and grand picture here
33-
| [traffic-analysis](../forensics/traffic-analysis) |
34-
| [volatile-memory-1](../forensics/volatile-memory-1) |
35-
| [volatile-memory-2](../forensics/volatile-memory-2) |
36-
| [where-did-you-go](../forensics/where-did-you-go) | Find the flag in this forensic disk image.
41+
| [alternate-reality](../forensics/alternate-reality) | [write-ups](alternate-reality)
42+
| [closed-creds](../forensics/closed-creds) | [write-ups](closed-creds)
43+
| [data-about-data](../forensics/data-about-data) | [write-ups](data-about-data)
44+
| [file-desc](../forensics/file-desc) | [write-ups](file-desc)
45+
| [HASH-browns](../forensics/HASH-browns) | [write-ups](HASH-browns)
46+
| [investigating-windows](../forensics/investigating-windows) | [write-ups](investigating-windows)
47+
| [pw-backup](../forensics/pw-backup) | [write-ups](pw-backup)
48+
| [traffic-analysis](../forensics/traffic-analysis) | [write-ups](traffic-analysis)
49+
| [volatile-memory-1](../forensics/volatile-memory-1) | [write-ups](volatile-memory-1)
50+
| [volatile-memory-2](../forensics/volatile-memory-2) | [write-ups](volatile-memory-2)
51+
| [where-did-you-go](../forensics/where-did-you-go) | [write-ups](where-did-you-go)
3752

53+
<!-- alternate-reality, closed-creds, data-about-data, file-desc, HASH-browns, investigating-windows, pw-backup, traffic-analysis, volatile-memory-1, volatile-memory-2, where-did-you-go -->
3854
## Misc
55+
* [Misc](../misc)
56+
3957
| Challenge | Write-ups
4058
| :----: | :----
59+
| [%20rainbows](../misc/%2520rainbows) | [write-ups](%2520rainbows)
60+
| [all-wrapped-up](../misc/all-wrapped-up) | [write-ups](all-wrapped-up)
61+
| ['Got_OSINT?'](../misc/Got_OSINT%3F)| [write-ups](Got_OSINT%3F)
62+
| [hidden-in-plain-sight-1](../misc/hidden-in-plain-sight-1) | [write-ups](hidden-in-plain-sight-1)
63+
| [hidden-in-plain-sight-2](../misc/hidden-in-plain-sight-2) | [write-ups](hidden-in-plain-sight-2)
64+
| [open-creds](../misc/open-creds)| [write-ups](open-creds)
65+
| [xymap](../misc/xymap) | [write-ups](xymap)
66+
67+
<!-- %2520rainbows, all-wrapped-up, Got_OSINT%3F, hidden-in-plain-sight-1, hidden-in-plain-sight-2, open-creds, xymap -->
4168

4269
## PWN
70+
* [PWN](../pwn)
71+
4372
| Challenge | Write-ups
4473
| :----: | :----
74+
| [64archInts](64archInts) | [write-ups](64archInts)
75+
| [exec](../pwn/exec) | [write-ups](exec)
76+
| [revPop](revPop) | [write-ups](revPop)
77+
| [sim-worker](sim-worker) | [write-ups](sim-worker)
78+
| [simple_buffo1](simple_buffo1) | [write-ups](simple_buffo1)
79+
| [simple_buffo2](simple_buffo2) | [write-ups](simple_buffo2)
80+
81+
<!-- 64archInts, exec, revPop, sim-worker, simple_buffo1, simple_buffo2 -->
4582

4683
## Web
84+
* [Web](../web)
85+
4786
| Challenge | Write-ups
4887
| :----: | :----
88+
| [clientside](../web/clientside) | [write-ups](clientside)
89+
| [insp3ctor](../web/insp3ctor)| [write-ups](insp3ctor)
90+
| [obligatory-robots](../web/obligatory-robots) | [write-ups](obligatory-robots)
91+
| [POST-UP](../web/POST-UP)| [write-ups](POST-UP)
92+
| [reDirector](../web/reDirector) | [write-ups](reDirector)
93+
94+
<!-- clientside, insp3ctor, obligatory-robots, POST-UP, reDirector -->
95+
96+
<!-- ["BlaiseDeCVE", "HideInside", "rail-fence", "rome", "rome-but-harder", "StegAESaurus", "Transformation", "XORED-Message", "alternate-reality", "closed-creds", "data-about-data", "file-desc", "HASH-browns", "investigating-windows", "pw-backup", "traffic-analysis", "volatile-memory-1", "volatile-memory-2", "where-did-you-go", "%2520rainbows", "all-wrapped-up", "Got_OSINT%3F", "hidden-in-plain-sight-1", "hidden-in-plain-sight-2", "open-creds", "xymap", "64archInts", "exec", "revPop", "sim-worker", "simple_buffo1", "simple_buffo2", "clientside", "insp3ctor", "obligatory-robots", "POST-UP", "reDirector"] -->
97+
98+
<!-- python script: python3 -c 'import sys, os; [os.mkdir(f"{name}") for name in ["BlaiseDeCVE", "HideInside", "rail-fence", "rome", "rome-but-harder", "StegAESaurus", "Transformation", "XORED-Message", "alternate-reality", "closed-creds", "data-about-data", "file-desc", "HASH-browns", "investigating-windows", "pw-backup", "traffic-analysis", "volatile-memory-1", "volatile-memory-2", "where-did-you-go", "%2520rainbows", "all-wrapped-up", "Got_OSINT%3F", "hidden-in-plain-sight-1", "hidden-in-plain-sight-2", "open-creds", "xymap", "64archInts", "exec", "revPop", "sim-worker", "simple_buffo1", "simple_buffo2", "clientside", "insp3ctor", "obligatory-robots", "POST-UP", "reDirector"]]'-->

0 commit comments

Comments
 (0)