Merge pull request #3 from wneessen/chore/test-coverage-and-deps

Add test coverage, CI and update deps

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: Winni Neessen <wn@neessen.dev>
+#
+# SPDX-License-Identifier: MIT
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      interval: daily

.github/workflows/ci.yml

@@ -0,0 +1,169 @@
+# SPDX-FileCopyrightText: Winni Neessen <wn@neessen.dev>
+#
+# SPDX-License-Identifier: MIT
+
+name: CI
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+
+jobs:
+    codecov:
+        name: Test with Codecov coverage (${{ matrix.os }} / ${{ matrix.go }})
+        runs-on: ${{ matrix.os }}
+        concurrency:
+            group: ci-codecov-${{ matrix.os }}-${{ matrix.go }}
+            cancel-in-progress: true
+        strategy:
+            matrix:
+                os: [ubuntu-latest]
+                go: ['1.24']
+        steps:
+            - name: Harden Runner
+              uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+              with:
+                  egress-policy: audit
+            - name: Checkout Code
+              uses: actions/checkout@61b9e3751b92087fd0b06925ba6dd6314e06f089 # master
+            - name: Setup go
+              uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
+              with:
+                  go-version: ${{ matrix.go }}
+                  check-latest: true
+            - name: Run go test
+              if: success()
+              run: |
+                go test -race -shuffle=on --coverprofile=coverage.coverprofile --covermode=atomic ./...
+            - name: Upload coverage to Codecov
+              if: success()
+              uses: codecov/codecov-action@1e68e06f1dbfde0e4cefc87efeba9e4643565303 # v5.1.2
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+    lint:
+        name: golangci-lint (${{ matrix.go }})
+        runs-on: ubuntu-latest
+        concurrency:
+            group: ci-lint-${{ matrix.go }}
+            cancel-in-progress: true
+        strategy:
+            matrix:
+                go: ['1.24']
+        steps:
+            - name: Harden Runner
+              uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+              with:
+                  egress-policy: audit
+            - name: Setup go
+              uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
+              with:
+                  go-version: ${{ matrix.go }}
+                  check-latest: true
+            - name: Checkout Code
+              uses: actions/checkout@61b9e3751b92087fd0b06925ba6dd6314e06f089 # master
+            - name: golangci-lint
+              uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6.1.1
+              with:
+                  version: latest
+    dependency-review:
+        name: Dependency review
+        runs-on: ubuntu-latest
+        concurrency:
+            group: ci-dependency-review
+            cancel-in-progress: true
+        steps:
+            - name: Harden Runner
+              uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+              with:
+                  egress-policy: audit
+            - name: Checkout Code
+              uses: actions/checkout@61b9e3751b92087fd0b06925ba6dd6314e06f089 # master
+            - name: 'Dependency Review'
+              uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0
+              with:
+                  base-ref: ${{ github.event.pull_request.base.sha || 'main' }}
+                  head-ref: ${{ github.event.pull_request.head.sha || github.ref }}
+    govulncheck:
+        name: Go vulnerabilities check
+        runs-on: ubuntu-latest
+        concurrency:
+            group: ci-govulncheck
+            cancel-in-progress: true
+        steps:
+            - name: Harden Runner
+              uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+              with:
+                  egress-policy: audit
+            - name: Run govulncheck
+              uses: golang/govulncheck-action@b625fbe08f3bccbe446d94fbf87fcc875a4f50ee # v1.0.4
+    test:
+        name: Test (${{ matrix.os }} / ${{ matrix.go }})
+        runs-on: ${{ matrix.os }}
+        concurrency:
+            group: ci-test-${{ matrix.os }}-${{ matrix.go }}
+            cancel-in-progress: true
+        strategy:
+            matrix:
+                os: [ubuntu-latest, macos-latest, windows-latest]
+                go: ['1.20', '1.21', '1.22', '1.23', '1.24']
+        steps:
+            - name: Harden Runner
+              uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+              with:
+                  egress-policy: audit
+            - name: Checkout Code
+              uses: actions/checkout@61b9e3751b92087fd0b06925ba6dd6314e06f089 # master
+            - name: Setup go
+              uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
+              with:
+                  go-version: ${{ matrix.go }}
+            - name: Run go test
+              run: |
+                go test -race -shuffle=on ./...
+    test-fbsd:
+        name: Test on FreeBSD ${{ matrix.osver }}
+        runs-on: ubuntu-latest
+        concurrency:
+            group: ci-test-freebsd-${{ matrix.osver }}
+            cancel-in-progress: true
+        strategy:
+            matrix:
+                osver: ['14.1', '14.2', '13.5']
+        steps:
+            - name: Checkout Code
+              uses: actions/checkout@61b9e3751b92087fd0b06925ba6dd6314e06f089 # master
+            - name: Run go test on FreeBSD
+              uses: vmactions/freebsd-vm@v1
+              with:
+                  usesh: true
+                  copyback: false
+                  prepare: |
+                    pkg install -y go
+                  run: |
+                    cd $GITHUB_WORKSPACE;
+                    go test -race -shuffle=on ./...
+    reuse:
+        name: REUSE Compliance Check
+        runs-on: ubuntu-latest
+        concurrency:
+            group: ci-reuse
+            cancel-in-progress: true
+        steps:
+            - name: Harden Runner
+              uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+              with:
+                  egress-policy: audit
+            - name: Checkout Code
+              uses: actions/checkout@61b9e3751b92087fd0b06925ba6dd6314e06f089 # master
+            - name: REUSE Compliance Check
+              uses: fsfe/reuse-action@bb774aa972c2a89ff34781233d275075cbddf542 # v5.0.0

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,82 @@
+# SPDX-FileCopyrightText: Winni Neessen <wn@neessen.dev>
+#
+# SPDX-License-Identifier: MIT
+
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '37 23 * * 5'
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Harden Runner
+      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
+      with:
+        egress-policy: audit
+
+    - name: Checkout repository
+      uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9

LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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.

argon2_test.go

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: Winni Neessen <wn@neessen.dev>
+//
+// SPDX-License-Identifier: MIT
+
 package iocrypter
 
 import (

codecov.yml

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: Winni Neessen <wn@neessen.dev>
+#
+# SPDX-License-Identifier: MIT
+
+coverage:
+  status:
+    project:
+      default:
+        target: 85%
+        threshold: 2%
+        base: auto 
+        if_ci_failed: error
+        only_pulls: false
+    patch:
+      default:
+        target: 80%
+        base: auto
+        if_ci_failed: error
+        threshold: 2%
+ignore:
+  - "cmd/"
+
+comment:
+  require_changes: true

decrypter.go

@@ -16,6 +16,10 @@ import (
 	"os"
 )
 
+// ErrTooLessRounds indicates that the provided number of rounds is smaller than the minimum
+// required threshold.
+var ErrTooLessRounds = errors.New("number of rounds too small")
+
 func NewDecrypter(r io.Reader, password []byte) (io.ReadCloser, error) {
 	aesKey, hmacKey, iv, header, err := readParameters(r, password)
 	if err != nil {
@@ -89,6 +93,9 @@ func NewDecrypter(r io.Reader, password []byte) (io.ReadCloser, error) {
 // readParameters reads and deserializes the Argon2 settings, salt, IV, and derives keys from the provided
 // reader and password.
 func readParameters(r io.Reader, password []byte) ([]byte, []byte, []byte, []byte, error) {
+	if len(password) == 0 {
+		return nil, nil, nil, nil, ErrPassPhraseEmpty
+	}
 	settingsSerialized := make([]byte, 9)
 	if _, err := io.ReadFull(r, settingsSerialized); err != nil {
 		return nil, nil, nil, nil, fmt.Errorf("failed to read Argon2 settings: %w", err)
@@ -112,6 +119,9 @@ func readParameters(r io.Reader, password []byte) ([]byte, []byte, []byte, []byt
 	header.Write(settingsSerialized)
 	header.Write(salt)
 	header.Write(iv)
+	if settings.Time < 1 {
+		return nil, nil, nil, nil, ErrTooLessRounds
+	}
 	aesKey, hmacKey := DeriveKeys(password, salt, settings)
 
 	return aesKey, hmacKey, iv, header.Bytes(), nil