Skip to content

SIRS (Network and Computer Security) Student Project Template

License

Notifications You must be signed in to change notification settings

tecnico-sec/Project-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CXX DeathNode / ChainOfProduct / CivicEcho Project Read Me

(replace CXX above with group identifier, for example, A07 ou T22)

(keep only your scenario name and delete the other names)

Team

Number Name User E-mail
11111 Alice Network https://github.com/AliceUser mailto:alice@tecnico.ulisboa.pt
22222 Bob Computer https://github.com/BobUser mailto:bob@tecnico.ulisboa.pt
33333 Charlie Security https://github.com/CharlieUser mailto:charlie@tecnico.ulisboa.pt

(fill table above with team member information)

Alice Bob Charlie

(add face photos with 150px height; faces should have similar size and framing)

Contents

This repository contains documentation and source code for the Network and Computer Security (SIRS) project.

The REPORT document provides a detailed overview of the key technical decisions and various components of the implemented project. It offers insights into the rationale behind these choices, the project's architecture, and the impact of these decisions on the overall functionality and performance of the system.

This document presents installation and demonstration instructions.

(adapt all of the following to your project, changing to the specific Linux distributions, programming languages, libraries, etc)

Installation

To see the project in action, it is necessary to setup a virtual environment, with N networks and M machines.

The following diagram shows the networks and machines:

(include a text-based or an image-based diagram)

Prerequisites

All the virtual machines are based on: Linux 64-bit, ...

Download and install a virtual machine.
Clone the base machine to create the other machines.

(above, replace witch actual links)

Machine configurations

For each machine, there is an initialization script with the machine name, with prefix init- and suffix .sh, that installs all the necessary packages and makes all required configurations in the a clean machine.

Inside each machine, use Git to obtain a copy of all the scripts and code.

$ git clone https://github.com/tecnico-sec/cxx...

(above, replace with link to actual repository)

Next we have custom instructions for each machine.

Machine 1

This machine runs ...

(describe what kind of software runs on this machine, e.g. a database server (PostgreSQL 16.1))

To verify:

$ setup command

(replace with actual commands)

To test:

$ test command

(replace with actual commands)

The expected results are ...

(explain what is supposed to happen if all goes well)

If you receive the following message ... then ...

(explain how to fix some known problem)

Machine ...

(similar content structure as Machine 1)

Demonstration

Now that all the networks and machines are up and running, ...

(give a tour of the best features of the application; add screenshots when relevant)

$ demo command

(replace with actual commands)

(IMPORTANT: show evidence of the security mechanisms in action; show message payloads, print relevant messages, perform simulated attacks to show the defenses in action, etc.)

This concludes the demonstration.

Additional Information

Links to Used Tools and Libraries

Versioning

We use SemVer for versioning.

License

This project is licensed under the MIT License - see the LICENSE.txt for details.

(switch to another license, or no license, as you see fit)


END OF README

About

SIRS (Network and Computer Security) Student Project Template

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •