Release of version 1.5.0

Author: gitlab-runner

.github/workflows/linting-test.yml

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Infineon Technologies AG
+# SPDX-License-Identifier: MIT
+
+name: REUSE Compliance Check
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: REUSE Compliance Check
+      uses: fsfe/reuse-action@v5

CHANGELOG.md

@@ -3,7 +3,29 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres to [Semantic
+Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.5.0 (2025-02-25)
+
+### Added
+- Support for new OPTIGA™ Trust M v3 firmware version v3.02.2564
+- New CLI feature: chipinfo readout
+- New CLI feature: interface parameter for interface selection
+- Support for I²C via gpiod
+- Example for signature creation and verification with Infineon pre-provisioned
+  key pair and certificate
+
+### Changed
+- Updated documentation: 
+    - Move to Infineon theme
+    - Move to mikroBUS™ shields as preferred setup
+    - General improvements and fixes
+- Completely removed `oscrypto` from project in favor of `cryptography` package
+- Updated Python package dependencies to latest versions
+
+### Fixed
+- Fixed an issue when importing a DER formatted x.509 certificate
 
 ## 1.4.3 (2024-11-29)
 
@@ -18,7 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Removed .reuse/dep5
 - Cleaned setup.py
-- Date of relese 1.4.1 fixed
+- Date of release 1.4.1 fixed
 
 ## 1.4.1 (2024-08-29)
 
@@ -32,7 +54,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - [Reuse](https://reuse.software/) compliancy
-- [Download script](extras/optiga-trust-m/download_libusb_windows.bat) for the download of LibUSB library and header for Windows
+- [Download script](extras/optiga-trust-m/download_libusb_windows.bat) for the
+  download of LibUSB library and header for Windows
 
 ### Changed
 - Moved to optiga-trust-m host library v5.x.x

CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+<!--
+SPDX-FileCopyrightText: Copyright (c) 2025 Infineon Technologies AG
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# Contributor Covenant Code of Conduct
+
+## Our pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[MAINTAINERS.md](MAINTAINERS.md). All complaints will be reviewed and
+investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary ban
+
+**Community impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent ban
+
+**Community impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

@@ -0,0 +1,155 @@
+<!--
+SPDX-FileCopyrightText: Copyright (c) 2025 Infineon Technologies AG
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
+# Contributing to this repository
+
+First off, thanks for taking the time to contribute!
+
+All types of contributions are encouraged and valued. See the [Table of
+contents](#table-of-contents) for different ways to help and details about how
+this project handles them. Please make sure to read the relevant section before
+making your contribution. It will make it a lot easier for us maintainers and
+smooth out the experience for all involved. The community looks forward to your
+contributions.
+
+## Table of contents
+
+- [I Have a question](#i-have-a-question)
+- [I Want to contribute](#i-want-to-contribute)
+  - [Reporting bugs](#reporting-bugs)
+  - [Suggesting enhancements](#suggesting-enhancements)
+
+## I Have a question
+
+> If you want to ask a question, we assume that you have read the available
+> [documentation](README.md).
+
+Before you ask a question, it is best to search for existing
+[issues](https://github.com/Infineon/python-optiga-trust/issues) that might help you.
+In case you have found a suitable issue and still need clarification, you can
+write your question in this issue. It is also advisable to search the internet
+for answers first.
+
+If you then still feel the need to ask a question and need clarification, we
+recommend the following:
+
+- Open an [issue](https://github.com/Infineon/python-optiga-trust/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (nodejs, npm, etc), depending on what
+  seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I want to contribute
+
+> ### Legal notice
+> 
+> When contributing to this project, you must agree that you have authored 100%
+> of the content, that you have the necessary rights to the content and that the
+> content you contribute may be provided under the project license.
+
+### Reporting bugs
+
+#### Before submitting a bug report
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Therefore, we ask you to investigate carefully, collect information
+and describe the issue in detail in your report. Please complete the following
+steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using
+  incompatible environment components/versions (Make sure that you have read the
+  [documentation](README.md). If you are looking for support, you might want to
+  check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the
+  same issue you are having, check if there is not already a bug report existing
+  for your bug or error in the [bug tracker](issues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if
+  users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+- Stack trace (traceback)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- Version of the interpreter, compiler, SDK, runtime environment, package
+  manager, depending on what seems relevant.
+- Possibly your input and the output
+- Can you reliably reproduce the issue? And can you also reproduce it with older
+  versions?
+
+#### How do I submit a good bug report?
+
+> You must never report security related issues, vulnerabilities or bugs
+> including sensitive information to the issue tracker, or elsewhere in public.
+> Instead sensitive bugs must be sent by email to one of the repository's
+> [maintainers](MAINTAINERS.md).
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the
+project:
+
+- Open an [issue](https://github.com/Infineon/python-optiga-trust/issues/new). (Since
+  we can't be sure at this point whether it is a bug or not, we ask you not to
+  talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction
+  steps* that someone else can follow to recreate the issue on their own. This
+  usually includes your code. For good bug reports you should isolate the
+  problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If
+  there are no reproduction steps or no obvious way to reproduce the issue, the
+  team will ask you for those steps and mark the issue as `needs-repro`. Bugs
+  with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as
+  well as possibly other tags (such as `critical`), and the issue will be left
+  to be implemented by someone.
+
+### Suggesting enhancements
+
+This section guides you through submitting an enhancement suggestion for this
+project, **including completely new features and minor improvements to existing
+functionality**. Following these guidelines will help maintainers and the
+community to understand your suggestion and find related suggestions.
+
+#### Before submitting an enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](README.md) carefully and find out if the
+  functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/Infineon/python-optiga-trust/issues) to see
+  if the enhancement has already been suggested. If it has, add a comment to the
+  existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's
+  up to you to make a strong case to convince the project's developers of the
+  merits of this feature. Keep in mind that we want features that will be useful
+  to the majority of our users and not just a small subset. If you're just
+  targeting a minority of users, consider writing an add-on/plugin library.
+
+#### How do I submit a good enhancement suggestion?
+
+Enhancement suggestions are tracked as [GitHub
+issues](https://github.com/Infineon/python-optiga-trust/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the
+  suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many
+  details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to
+  see instead** and why. At this point you can also tell which alternatives do
+  not work for you.
+- You may want to **include screenshots and animated GIFs** which help you
+  demonstrate the steps or point out the part which the suggestion is related
+  to.
+- **Explain why this enhancement would be useful** to most users of this
+  project. You may also want to point out the other projects that solved it
+  better and which could serve as inspiration.
+
+## Attribution
+
+This guide is based on the
+[contributing-gen](https://github.com/bttger/contributing-gen)!

INSTALL.md

@@ -2,7 +2,9 @@
 
 ## Dependencies
 
-The `optigatrust` Python module depends on the modules in [requirements.txt](requirements.txt). For testing, the additional dependencies in [tests/requirements.txt](tests/requirements.txt) have to be installed.
+The `optigatrust` Python module depends on the modules in
+[requirements.txt](requirements.txt). For testing, the additional dependencies
+in [tests/requirements.txt](tests/requirements.txt) have to be installed.
 
 ```bash
 python -m pip install -r ./requirements.txt
@@ -15,4 +17,4 @@ To install this Python module from sources, run the following command.
 
 ```bash
 python -m pip install .
-```
+```