Add library functions (#1)

.github/workflows/main.yml

@@ -1,43 +1,48 @@
 name: main
 
-on: [push]
+on: [ push ]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7']
+        python-version: [ 3.7, 3.8, 3.9, "3.10" ]
 
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
+      - name: Install poetry
+        run: pipx install poetry
 
-    - uses: Gr1N/setup-poetry@v8
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "poetry"
 
-    - name: Check dependencies
-      run: make doctor
+      - name: Install poetry dependencies
+        run: poetry install
 
-    - uses: actions/cache@v2
-      with:
-        path: .venv
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+      - name: Check dependencies
+        run: make doctor
 
-    - name: Install dependencies
-      run: make install
+      - uses: actions/cache@v2
+        with:
+          path: .venv
+          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
 
-    - name: Check code
-      run: make check
+      - name: Install dependencies
+        run: make install
 
-    - name: Test code
-      run: make test
+      - name: Check code
+        run: make check
 
-    - name: Upload coverage
-      uses: codecov/codecov-action@v1
-      with:
-        fail_ci_if_error: true
+      - name: Test code
+        run: make test
+
+#      - name: Upload coverage
+#        uses: codecov/codecov-action@v1
+#        with:
+#          fail_ci_if_error: true

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black

.python-version

@@ -0,0 +1 @@
+3.7.11

Makefile

@@ -36,12 +36,10 @@ $(DEPENDENCIES): poetry.lock
 	@ rm -rf ~/Library/Preferences/pypoetry
 	@ poetry config virtualenvs.in-project true
 	poetry install
-	@ touch $@
 
 ifndef CI
 poetry.lock: pyproject.toml
 	poetry lock --no-update
-	@ touch $@
 endif
 
 .cache:

README.md

@@ -1,16 +1,29 @@
-# Overview
+![Horizontal Lockupblack](https://user-images.githubusercontent.com/293079/169453889-ae211c6c-7634-4ccd-8ca9-8970c2621b6f.png#gh-light-mode-only)
+![Horizontal Lockup copywhite](https://user-images.githubusercontent.com/293079/169453892-895f637b-4633-4a14-b997-960c9e17579b.png#gh-dark-mode-only)
 
-Sample project generated from Jace's Python Template.
+# Anvil Encryption
 
-This project was generated with [cookiecutter](https://github.com/audreyr/cookiecutter) using [jacebrowning/template-python](https://github.com/jacebrowning/template-python).
-
-[![Unix Build Status](https://img.shields.io/github/actions/workflow/status/anvilco/python-anvil-encryption/main.yml?branch=main&label=linux)](https://github.com/anvilco/python-anvil-encryption/actions)
-[![Windows Build Status](https://img.shields.io/appveyor/ci/anvilco/python-anvil-encryption.svg?label=windows)](https://ci.appveyor.com/project/anvilco/python-anvil-encryption)
-[![Coverage Status](https://img.shields.io/codecov/c/gh/anvilco/python-anvil-encryption)](https://codecov.io/gh/anvilco/python-anvil-encryption)
-[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/anvilco/python-anvil-encryption.svg)](https://scrutinizer-ci.com/g/anvilco/python-anvil-encryption)
 [![PyPI License](https://img.shields.io/pypi/l/python-anvil-encryption.svg)](https://pypi.org/project/python-anvil-encryption)
 [![PyPI Version](https://img.shields.io/pypi/v/python-anvil-encryption.svg)](https://pypi.org/project/python-anvil-encryption)
-[![PyPI Downloads](https://img.shields.io/pypi/dm/python-anvil-encryption.svg?color=orange)](https://pypistats.org/packages/python-anvil-encryption)
+
+This library is a small wrapper around the [`pypa/cryptography` library](https://cryptography.io/en/latest/).
+It offers convenience methods for encrypting and decrypting arbitrary payloads in both AES and RSA.
+
+For use encrypting / decrypting payloads in Anvil, you can generate an RSA keypair from
+your [organization's settings page](https://www.useanvil.com/docs/api/getting-started#encryption).
+
+[Anvil](www.useanvil.com/developers) provides easy APIs for all things paperwork.
+
+1. [PDF filling API](https://www.useanvil.com/products/pdf-filling-api/) - fill out a PDF template with a web request
+   and structured JSON data.
+2. [PDF generation API](https://www.useanvil.com/products/pdf-generation-api/) - send markdown or HTML and Anvil will
+   render it to a PDF.
+3. [Etch E-sign with API](https://www.useanvil.com/products/etch/) - customizable, embeddable, e-signature platform with
+   an API to control the signing process end-to-end.
+4. [Anvil Workflows (w/ API)](https://www.useanvil.com/products/workflows/) - Webforms + PDF + E-sign with a powerful
+   no-code builder. Easily collect structured data, generate PDFs, and request signatures.
+
+Learn more about Anvil on our [Anvil developer page](https://www.useanvil.com/developers).
 
 ## Setup
 
@@ -34,10 +47,39 @@ $ poetry add python-anvil-encryption
 
 ## Usage
 
-After installation, the package can be imported:
+This usage example is also in a runnable form in the `examples/` directory.
 
-```text
-$ python
->>> import python-anvil-encryption
->>> python-anvil-encryption.__version__
+```python
+import os
+from python_anvil_encryption import encryption
+
+CURRENT_PATH = os.path.dirname(os.path.realpath(__file__))
+
+# Keys could be read from a file (or preferably from environment variables)
+public_key = None
+private_key = None
+with open(os.path.join(CURRENT_PATH, "keys/public.pub"), "rb") as pub_file:
+    public_key = pub_file.read()
+
+with open(os.path.join(CURRENT_PATH, "./keys/private.pem"), "rb") as priv_file:
+    private_key = priv_file.read()
+
+# RSA
+message = b"Super secret message"
+encrypted_message = encryption.encrypt_rsa(public_key, message)
+decrypted_message = encryption.decrypt_rsa(private_key, encrypted_message)
+assert decrypted_message == message
+print(f"Are equal? {decrypted_message == message}")
+
+# AES
+aes_key = encryption.generate_aes_key()
+aes_encrypted_message = encryption.encrypt_aes(aes_key, message)
+# The aes key in the first parameter is required to be in a hex
+# byte string format.
+decrypted_message = encryption.decrypt_aes(
+    aes_key.hex().encode(),
+    aes_encrypted_message
+)
+assert decrypted_message == message
+print(f"Are equal? {decrypted_message == message}")
 ```

docs/about/changelog.md

@@ -0,0 +1 @@
+../../CHANGELOG.md

docs/about/contributing.md

@@ -0,0 +1 @@
+../../CONTRIBUTING.md

docs/about/license.md

@@ -0,0 +1 @@
+../../LICENSE.md

docs/index.md

@@ -0,0 +1 @@
+../README.md

docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs==1.3.1 ; python_full_version >= "3.7.2" and python_version < "3.12"
+pygments==2.16.1 ; python_full_version >= "3.7.2" and python_version < "3.12"
+jinja2==3.1.2 ; python_full_version >= "3.7.2" and python_version < "3.12"

examples/decrypt_payload.py

@@ -0,0 +1,38 @@
+import os
+from python_anvil_encryption import encryption
+
+CURRENT_PATH = os.path.dirname(os.path.realpath(__file__))
+
+
+def main():
+    # Read your public and private keys
+    public_key = None
+    private_key = None
+    with open(os.path.join(CURRENT_PATH, "keys/public.pub"), "rb") as pub_file:
+        public_key = pub_file.read()
+
+    with open(os.path.join(CURRENT_PATH, "./keys/private.pem"), "rb") as priv_file:
+        private_key = priv_file.read()
+
+    # RSA
+    message = b"Super secret message"
+    encrypted_message = encryption.encrypt_rsa(public_key, message)
+    decrypted_message = encryption.decrypt_rsa(private_key, encrypted_message)
+    assert decrypted_message == message
+    print(f"Are equal? {decrypted_message == message}")
+
+    # AES
+    aes_key = encryption.generate_aes_key()
+    aes_encrypted_message = encryption.encrypt_aes(aes_key, message)
+    # The aes key in the first parameter is required to be in a hex
+    # byte string format.
+    decrypted_message = encryption.decrypt_aes(
+        aes_key.hex().encode(), aes_encrypted_message
+    )
+    assert decrypted_message == message
+    print(f"Are equal? {decrypted_message == message}")
+
+
+if __name__ == "__main__":
+    main()
+    print(CURRENT_PATH)

examples/keys/private.pem

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQChxcVVacwOBjGL
+vNlDCZyeD4eaS8Rkhrwb5HcFonjgc7qVtrNq/VnmbALsc8QZ3pLFO8LWia3zGY5c
+mirCbFl+RpBX1lmdFSaBQZhH0obVDNgqwG1R2Pho1xEyyUXGggQoY7AqvfliGTmL
+8LerdmUBF+o2fSgpRXCiUWZ+nUyLni8NH5nI7mX25+SPRFwvbLkK17frTNnUFGaM
+Ah05XOHVDQPFOKeWkQusIDCjdKZbLq+1Rlf/5/F4balGhCkLsuiV23rnNJUEWGKr
+686VkcRBuMe8PQzdePs6lUJd9I8qHPeIDUj8vEEyA2jHBLu+f1GINvzfDVEATV+2
+KAc+XK8TAgMBAAECggEBAJ9ut023h/imV/wc8Y5lEaqhKYaCd5qPQyLGJhsyhajH
+xbK5LdgaupgiCTuZ2EGantGtVRd09y+oFyricZPNjuGpj6ZRxV3Ps3Qd/oOCU4nz
+L7Pqk5Lfn+pLU1LXFGJQTuKzZLKrKfVpYNKvOYTNmTvbouNys7sBCcGfMcFFK2RI
+vA5QGjH75KTzYkgeRuEOkMDSn7XNZup8D6HOD8rqMEqmqf0T7LK/+Ui+Lv+0SFHW
+bBsHE8WGpvf02szLv8yr5PlVjj/2krrjuxj7TxyDf8bFBcSR+YFCD2IV9DqHfVAL
+v5xRETxPXrIuUdRE12ywXX9Rs1gDBtbi8IUAdJs0wrkCgYEA5+hSXMxJ90VaAPxa
+yE7oxwjssqOu/XODzae3eVh/RQIw0iVcu9eQmLByAZRC0yRtmL38UDOxPglquQR8
+MAQv9G5yhDY/3tK1vXWpaibBiDzv3OAv4Sh6+rKgdfP4RaWozmGWGT+4REPN1Iwh
+hrSQGpa1Loo+ysB2WF+LtcRFepcCgYEAspQuF8PdT3g0t3lGLW0x57ZydcRN/zmW
+b17UPUplAXdRm1IcZn5lytb25UtvYus69+DWzLwfwhGKWGagzcojOWJHMzVNd9R5
+kEEEyXKq4Yzadzy/H+wqiaL+euoELuJlnbCBJQYAX417wM81NK0P3o3Z9cT8IBYA
+e0aL6zQY6uUCgYEAycw7f0y1QFo0y47MYGlp3WhCr+AHMb0HADnlSc5cUOxrFzIz
+07DsvjErw3wD+j9ErxkDKbcRkG4ZVA43EoFSSVyigbHDOl4Yj1iHpzs6RRbhkk3y
+2/ahrO0q+/jkHZbdoVkBh88OxThLL50Qv2r3ymtCFdFueneng5cAt5am7tkCgYAH
+LWF03xBkA0bLIPqrFLpuv6x2Az/HRD9BlqQdGoJYvrzu6yvtCqN4tY8SxCdj6GRk
+VgsMC3uTRzUyPF22J6umwMZvznKgoE+KdrKEjjFEA288X5qm480J3x0vP3yPjdXb
+sp5eKJGXRY51v146EcKThUv/Tr17ZKb8TWeOOnfN6QKBgGBJH2XywacG1VPS6Yg2
+T4JoRWiwsaH/8En/dDUO6/YOOPasA28i4VW1xtNZPqk2Kd4Fg+zWZE1pt5w4MKyb
+6kSISSo9NOC3LN3WyEqBa3XcRYFb2cggK0EvaJQ+a8bzhcSSzrGvbKFgk9O1QGud
+ZjGQrTXebogFV+uB2sUsL5oR
+-----END PRIVATE KEY-----