Data

Tools

Indexes

Applications

Experiments

Open Source Science

brski-py

A "Bootstrapping Remote Secure Key Infrastructure" (BRSKI) Demonstrator in Python

https://github.com/dermrvn-code/brski-py

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

brski cybersecurity pki python
Last synced: 6 months ago · JSON representation ·

Repository

A "Bootstrapping Remote Secure Key Infrastructure" (BRSKI) Demonstrator in Python

Basic Info
  • Host: GitHub
  • Owner: dermrvn-code
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 360 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
brski cybersecurity pki python
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

readme.md



Bootstrapping Remote Secure Key Infrastructure in Python

Information

For a more detailed description of this project, please refer to the corresponding paper 10.5281/zenodo.13934557.

Table of Contents

Installation

To install the BRSKI Python Implementation, follow these steps:

  1. Clone the repository:

shell git clone https://github.com/dermrvn-code/BRSKI-PY

  1. Navigate to the project directory:

shell cd BRSKI-PY

  1. Install the required dependencies:

shell py install.py

Now everything is successfully installed and the BRSKI Python Implementation can be used.

Usage

To use the BRSKI Python Implementation, follow these steps:

  1. Start the environment:

In every new terminal session, you need to start the environment by running the following command:

shell start_env.bat

  1. Adjust the configuration

It might be necessary to adjust some configurations in the config.ini file.

  1. Open the config.ini file

  2. Revise the configurations, especially the ports of the different servers

  3. Check if the preset ports are already in use on your machine

  4. Adjust the ports if necessary

  5. Save the file

    1. Generate the necessary certificates:

Be sure to set the correct ports beforehand, as some certificates get embedded URLs, with the ports specified in the config.ini.

When starting the demonstrator for the first time, you need to generate all the necessary keys and certificates.
To do so, follow these steps:

  1. Run the script to generate all the necessary keys and certificates:

shell py brski-py/Certificates/generate_certificates.py

  1. Start the demonstrator:

  • Call the start_all.py script if already in environment:

    shell py start_all.py

  • Or start the demonstrator by just opening the start.bat file:

    shell start.bat

  1. Reset the demonstrator:

If you want to reset the demonstrators logs and saved statuses, you can do so by running the brski-py/reset_process.py script:

shell py brski-py/reset_process.py

Generate Docs

To generate a sphinx documentation for the BRSKI Python Implementation, follow these steps:

  1. Start the virtual environment:

shell start_env.bat

  1. Navigate to the docs directory:

shell cd docs

  1. Build the documentation:

shell build_docs.bat

  1. If the documentation was successfully built, you can find the HTML files in the docs/build/html directory.

(Back to top)

Owner

  • Name: Marvin
  • Login: dermrvn-code
  • Kind: user
  • Location: Lippstadt

just coding.

Citation (CITATION.cff) 

# @format

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: BRSKI-PY
message: Please cite this software using these metadata.
type: software
authors:
  - given-names: Marvin
    family-names: Grunwald
license: MIT

GitHub Events

Total
  • Watch event: 3
  • Push event: 1
Last Year
  • Watch event: 3
  • Push event: 1

Dependencies

requirements.txt pypi
  • Pygments ==2.18.0
  • certifi ==2024.6.2
  • cffi ==1.16.0
  • charset-normalizer ==3.3.2
  • cryptography ==42.0.8
  • idna ==3.7
  • pyOpenSSL ==24.1.0
  • pyasn1 ==0.6.0
  • pycparser ==2.22
  • python-dotenv ==1.0.1
  • requests ==2.32.3
  • setuptools ==70.0.0
  • urllib3 ==2.2.1
  • wheel ==0.43.0