chore: initial commit

Author: max-wittig

.github/ISSUE_TEMPLATE/issue_template.md

@@ -0,0 +1,23 @@
+---
+name: Issue report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description of the problem, including code snippet
+
+
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Specifications
+
+* python-smime-email version:
+* OS name:
+* OS version:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+<!-- Please make sure your commit messages follow Conventional Commits
+(https://www.conventionalcommits.org) with a commit type (e.g. feat, fix, refactor, chore):
+
+Bad:        Added support for release links
+Good:     feat(api): add support for release links
+
+Bad:        Update documentation for projects
+Good:     docs(projects): update example for saving project attributes-->
+
+## Changes
+
+<!-- Remove this comment and describe your changes here. -->
+
+### Documentation and testing
+
+Please consider whether this PR needs documentation and tests. **This is not required**, but highly appreciated:
+
+* [ ] Documentation in the README
+* [ ] Unit tests

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - name: Install poetry
+      run: python3 -m pip install --user poetry==1.8.3
+    - name: Build wheel
+      run: poetry build
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Test
+
+# If a pull-request is pushed then cancel all previously running jobs related
+# to that pull-request
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true 
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+env:
+  PY_COLORS: 1
+
+jobs:
+  unit:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python:
+          - version: "3.10"
+          - version: "3.11"
+          - version: "3.12"
+          - version: '3.13.0-alpha - 3.13' # SemVer's version range syntax
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python.version }}
+        uses: actions/setup-python@v5.2.0
+        with:
+          python-version: ${{ matrix.python.version }}
+      - run: |
+          python3 -m pip install --user -r requirements-poetry.txt
+          sudo apt-get update && sudo apt-get -y install openssl
+          poetry install -n
+          poetry run poe lint
+          poetry run poe test

.gitignore

@@ -0,0 +1,10 @@
+__pycache__
+.env
+dist
+.pytest_cache
+htmlcov
+.mypy_cache
+.coverage
+coverage.xml
+junit.xml
+.ruff_cache

CODE-OF-CONDUCT.md

@@ -0,0 +1,124 @@
+# 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+opensource@siemens.com.
+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].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CODEOWNERS

@@ -0,0 +1 @@
+./** @siemens/python-maintainers

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing to python-smime-email
+
+Contributions are always welcome. This document explains the
+general requirements on contributions and the recommended preparation
+steps.
+
+## Contribution Checklist
+
+- try to cover new features or fixes with accompanying tests
+- follow Python coding style outlined in ruff [**required**]

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Siemens AG, 2024
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,43 @@
+# python-smime-email
+
+<a href="https://pypi.org/project/smime-email/"><img alt="PyPI" src="https://img.shields.io/pypi/v/smime-email"></a>
+<a href="https://pepy.tech/project/smime-email"><img alt="Downloads" src="https://pepy.tech/badge/smime-email"></a>
+
+Generate x509 SMIME signed emails with ease!
+
+## Usage
+
+1. Generate the email raw content
+
+    ```python
+    import smime_email
+
+    data = b"Hello!"
+    SMIME_KEY = smime_email.load_key("key_path.pem")
+    SMIME_INTERMEDIATE = smime_email.load_certificates("intermediate_path.pem")
+    SMIME_CERT = smime_email.load_certificates("cert_path.pem")[0]
+    email_raw_bytes = smime_email.get_smime_attachment_content(data, SMIME_KEY, SMIME_INTERMEDIATE, SMIME_CERT)
+    ```
+
+1. Send it using any email library you like. Here is an example as Django email backend
+
+    ```python
+    email_raw_bytes = smime_email.get_smime_attachment_content(data, SMIME_KEY, SMIME_INTERMEDIATE, SMIME_CERT)
+    # ...
+    class EmailBackend(BaseEmailBackend):
+        def send_messages(self, message) -> int:
+            with smtplib.SMTP(settings.EMAIL_HOST, settings.EMAIL_PORT) as server:
+                server.sendmail(message.from_email, message.to, email_raw_bytes)
+            return 1
+    ```
+
+## Development
+
+The code is formatted with **ruff** and checked with various linters.
+To run the whole linting and formatting process, run `poetry run poe all`.
+
+## License
+
+Code and documentation copyright 2024 Siemens AG.
+
+See [LICENSE.md](LICENSE.md).