Klagarge/MSE-CyberSec-DevSecOps
1
0
Fork 0
Code Issues Pull Requests Releases Activity

setup season 2425 with first part of the questions

Browse Source
This commit is contained in:
Michael Mäder
2025-03-10 09:09:00 +01:00
parent ef39d82ad9
commit ec709475c0
12 changed files with 446 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
README.md
View File

@@ -1,93 +1,104 @@
# MSE DevSecOps 2425
# CI/CD and SSDLC labs (TSM CyberSec) 2425
## Getting started
On this page you'll find the lab(s) for the TSM CyberSec course.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Organization
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
The labs is finally only one lab in which you build a CI/CD pipeline with the main focus on security add-ons. This will include:
## Add your files
* unit tests
* coverage tests
* SAST integration
* DAST integration
* data leakage prevention
* ... and much more
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
The lab will be performed in groups of two students.
```
cd existing_repo
git remote add origin https://gitlab.forge.hefr.ch/devsecops/mse/mse-devsecops-2425.git
git branch -M main
git push -uf origin main
```
## Evaluation
## Integrate with your tools
The groups (pair) will be evaluated.
- [ ] [Set up project integrations](https://gitlab.forge.hefr.ch/devsecops/mse/mse-devsecops-2425/-/settings/integrations)
Any work is stored by the groups in their own Git repo, in the **`main` branch**. This contains:
## Collaborate with your team
* Code
* CI/CD pipeline
* Documentation
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
The documentation contains the answers to all the questions asked. It is a rolling lab, which means, that additional questions will come each week. Use the question files (e.g. `docs/question-part1.md`) for your answers! (--> Overall duration of the lab approximately 5 weeks)
## Test and Deploy
### Grading
Use the built-in continuous integration in GitLab.
How is the lab graded?
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
- If you answer the questions correctly, you have the grade 5.0
- To get more than 5.0, you must for example :
- propose an original solution
- deepen one or more themes
- answer the optional questions of the labs (if there are any)
***
# Editing this README
### Submission
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
All your work must be terminated and commit to your *group repo* at latest **16.04.2024**
## Suggestions for a good README
## Preparation
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
You must (in the pair) fork the Git Repo that contains an example Web-API application with a minimalistic CI/CD pipeline. This repo will build the starting point for all your upcoming lab tasks. These preparation steps will be done together in class
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
### Tasks
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
1. Fork this git repo here https://gitlab.forge.hefr.ch/devsecops/mse-dev-sec-ops-2324
- Get some inspiration [here](https://concurp.pages.forge.hefr.ch/2022-2023/website/lab00/) how to fork a repo
2. Give **Maintainer** access to your colleague in your group
3. Give **Developer** access to the professor (@michael.maeder)
4. Clone your newly created repo to your local machine and `cd` into the directory
5. Set the `upstream` to the main repo to get any updates
* `git remote add upstream git@gitlab.forge.hefr.ch:devsecops/mse-dev-sec-ops-2324.git`
6. `git pull upstream main` will update your fork repo with the latest changes from the main repo
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
# Lab envrionment setup
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
In the first part, the lab will be mainly a setup of the environment for everybody to ensure that you can work correctly. The basics will be shown directly in the course.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Currently the following directory structure exists:
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
* **docs**: place for you to put your documentation, explanations, answers, graphics, etc
* **src**: a minimalistic web application (written in Python 3.x) that can perform the following calculations:
* addition / subtraction
* multiplication
* division
* **tests**: test comes here (e.g. unit tests, coverage, ...)
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
## Analysis of the application and the existing pipeline
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You must understand the application, how it works, the basics of Flask (as web platform) and of course the automation processes (CI/CD) for testing, building, etc. the application.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Usage of the API
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
*see README.md in the `src` directory*
## License
For open source projects, say how it is licensed.
## Basic pipeline
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
The provided basic pipeline description `.gitlab-ci.yml` is **not optimized at all**. It works in a *shaky* way and does the following tasks:
- run the unit tests (described in `src/tests`)
- checks the test coverage
- create a test and coverage report in HTML format, which is then accessible through **your** gitlab pages (e.g. `https://devsecops.pages.forge.hefr.ch/mse-dev-sec-ops-2223/`)
## The questions
The questions for all the parts can be found in the [questions-partX.md files](./docs/) file in the docs directory. You can write your answers directly into these files if you wish.
# Resources
* [TSM Cybersecurity Moodle](https://moodle.msengineering.ch/course/view.php?id=2376)
* [Lecture notes](https://heia-fr-maeder.github.io/mse_cybersec)
* [Coverage report](hhttps://mse-dev-sec-ops-2324-devsecops-mse-fd7bb329cbf2fd39e71840cb4686.pages.forge.hefr.ch/)
* [Short Intro to CI/CD](https://www.youtube.com/watch?v=l5705U8s_nQ&t=358s)
* [How to make your code shine with Gitlab CI pipelines](https://medium.com/semantixbr/how-to-make-your-code-shine-with-gitlab-ci-pipelines-48ade99192d1)