setup season 2425 with first part of the questions

.gitignore

@@ -0,0 +1,7 @@
+.idea/
+__pycache__/
+.coverage
+.envrc
+.devcontainer/
+
+src/.pdm-python

.gitlab-ci.yml

@@ -0,0 +1,34 @@
+stages:
+  - build
+
+
+build job:
+  stage: build
+  script:
+    - cd src
+    - apt-get update -qy
+    - apt-get install -y python3-dev python3-pip python3.10-venv
+    - python3 -V
+    - pip install pdm
+    - pdm install
+    # launch tests
+    - export PYTHONPATH=.
+    - export FLASK_APP=app
+    - pdm run pytest --cov --cov-report term --cov-report html
+  artifacts:
+      paths:
+        - src/htmlcov/
+
+pages:
+  stage: build
+  dependencies:
+    - build job
+  needs: ["build job"]
+  script:
+    - mv src/htmlcov/ public/
+  artifacts:
+    paths:
+      - public
+    expire_in: 7 days
+  only:
+    - main

README.md

@@ -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)

docs/README.md

@@ -0,0 +1,15 @@
+# Docs directory
+This directory contains the questions (peer week), which will dynamically be added.
+
+Also in this directory you can put all kind of documentation that should be read by the professor at the end of the lab. And of course you put your answers to this directory.
+
+Please use the following formats:
+
+* put your answers directly into the markdown files (.md) in this directory (this can include of course any kind of code, graphics, etc.)
+* PDF files
+
+# Questions
+
+The questions (per week) will be added and available directly in the questionX.md files:
+
+- [Questions 1](./questions-part1.md)

docs/questions-part1.md

@@ -0,0 +1,8 @@
+# Questions - Part 1
+
+## Unit tests - Secret keys - Linter - optimized CI/CD pipeline
+
+- **Q1.1**: Provide additional unit tests to ensure that wrong input (type, values, ...) doesn't crash the application, but gets intercepted and produce a controlled error. It is possible that you have also to adjust slightly the application
+- **Q1.2**: The secret key for flask is hard coded. Is this good practice? What are the dangers? How could this be fixed?
+- **Q1.3**: Give a short description of *Linter*. Integrate a basic linter like [Flake8](https://flake8.pycqa.org/en/latest/) or [Ruff](https://github.com/astral-sh/ruff) in the existing CI/CD pipeline
+- **Q1.4 (optional)**: The run of the current CI/CD pipeline takes some time. Especially the time to setup the docker with the update and installation of all the dependencies is quite time consuming compared to the real testing time. Do you see any alternatives to speed up this process? Describe and try to implement it in your pipeline.

misc/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm-project.org/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

misc/README.md

@@ -0,0 +1,3 @@
+# misc
+
+Playground for different demos.

src/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit=/usr/local/lib/python3.10/dist-packages/*

src/app.py

@@ -0,0 +1,98 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2025, School of Engineering and Architecture of Fribourg
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from flask import request, Flask, url_for, render_template, redirect
+import operators
+import json
+
+
+__author__ = 'Michael Mader'
+__date__ = "2025-03-10"
+__version__ = "0.5"
+__email__ = "michael.maeder@hefr.ch"
+
+
+"""
+DevSecOps lab
+
+A little web application that offers API calls for arithmetic operations
+"""
+
+
+# creation of the Flask application
+app = Flask(__name__)
+
+app.config['SECRET_KEY'] = 'the-best-secret-ever'   # super secure key against CSRF attacks
+
+# global variable containing the name of the login user
+global_data = {'username': 'no_user'}
+
+
+# incrementation route
+@app.route('/inc')
+def plus_one():
+    x = int(request.args.get('x', 1))
+    return json.dumps({'x': operators.addition(x, 1)})
+
+# addition route, the parameters will be passed with 'x' and 'y'
+@app.route('/add')
+def plus_y():
+    x = int(request.args.get('x', 1))
+    y = int(request.args.get('y', 1))
+    return json.dumps({'result': operators.addition(x, y)})
+
+
+# multiplication route, the parameters will be passed with 'x' and 'y'
+@app.route('/mul')
+def multiply_y():
+    x = int(request.args.get('x', 1))
+    y = int(request.args.get('y', 1))
+    return json.dumps({'result': operators.multiplication(x, y)})
+
+
+# division route, the parameters will be passed with 'x' and 'y'
+@app.route('/div')
+def division_y():
+    x = int(request.args.get('x', 1))
+    y = int(request.args.get('y', 1))
+    return json.dumps({'result': operators.division(x, y)})
+
+
+# help route, giving some information about the API
+@app.route('/help')
+def unused():
+    return "Super calculator API"
+
+
+# default route, just showing the main page
+@app.route('/')
+@app.route('/index')
+def index():
+    return render_template('index.html', title='Home', app_data=global_data, )
+
+
+# login route, the given username will be used to welcome the user
+@app.route('/login', methods=['GET', 'POST'])
+def login():
+    # handle the POST request
+    if request.method == 'POST':
+        username = request.form["username"]
+        print(f"got: {username}")
+        global_data['username'] = request.form.get('username')
+        return redirect(url_for('index'))
+    # otherwise handle the GET request
+    return render_template('login.html', title='Sign In',)

src/operators.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2024, School of Engineering and Architecture of Fribourg
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__author__ = 'Michael Mader'
+__date__ = "2023-03-12"
+__version__ = "0.2"
+__email__ = "michael.maeder@hefr.ch"
+
+
+# file containing the operations for the calculator
+
+# addition: returns x+y 
+def addition(x, y):
+    return x+y
+
+
+# subtraction: returns x-y 
+def subtraction(x, y):
+    return x-y
+
+
+# multiplication: returns x*y 
+def multiplication(x, y):
+    return x*y
+
+
+# division: returns x/y
+#   returns None if the divisor is zero
+#   the result might be of float type
+def division(x, y):
+    if y==0:
+        return None
+    return x/y