Merge branch 'main' into greendoescode/volariscore

.github/workflows/buildandrelease.yml

@@ -0,0 +1,129 @@
+name: Build and Upload
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+    branches: [ main ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  clippy:
+    name: clippy (ubuntu-latest, stable)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+        components: clippy
+
+    - name: Restore cargo cache
+      uses: actions/cache@v2.1.7
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ runner.os }}-cargo-stable-${{ hashFiles('Cargo.lock') }}
+
+    - name: Clippy
+      uses: actions-rs/cargo@v1
+      with:
+        command: clippy
+        args: --no-deps
+
+  check:
+    name: check (ubuntu-latest, stable)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+
+    - name: Restore cargo cache
+      uses: actions/cache@v2.1.7
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ runner.os }}-cargo-stable-${{ hashFiles('Cargo.lock') }}
+
+    - name: Check
+      uses: actions-rs/cargo@v1
+      with:
+        command: check
+        args: --release
+
+  build:
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        rust:
+          - stable
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: ${{ matrix.rust }}
+          override: true
+
+      - name: Restore cargo cache
+        uses: actions/cache@v2.1.7
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ matrix.os }}-cargo-${{ matrix.rust }}-${{ hashFiles('Cargo.lock') }}
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --release
+
+      - if: matrix.os != 'windows-latest'
+        name: Strip\
+        run: strip target/release/volaris-cli
+
+      - if: matrix.os == 'ubuntu-latest'
+        name: Hash the Binary
+        run: sha256sum target/release/volaris-cli
+
+      - if: matrix.os == 'ubuntu-latest'
+        name: Upload Binary as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: volaris-cli-linux64
+          path: target/release/volaris-cli
+      - if: matrix.os == 'macos-latest'
+        name: Upload Binary as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: volaris-cli-mac64
+          path: target/release/volaris-cli
+      - if: matrix.os == 'windows-latest'
+        name: Upload Binary as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: volaris-cli-win64
+          path: target/release/volaris-cli.exe

README.md

@@ -13,10 +13,8 @@ Volaris is an encryption tool designed to prioritize privacy and security. Built
 
 ## Security
 
-Volaris uses modern cryptographic AEADs (XChaCha20-Poly1305 + AES-256-GCM),
-with audited backends to ensure the safety and integrity of
-your data. It's extremely easy to use Volaris before uploading your files to a
-cloud service, to ensure that no prying eyes can read them.
+Volaris uses modern cryptographic methods (XChaCha20-Poly1305 + AES-256-GCM), with audited backends to keep the safety of
+your data. Using Volaris before sharing your files is effortless, keeping them safe in transit.
 
 ## Current Status
 

crates/volaris-crypto/README.md

@@ -10,7 +10,6 @@ decryption.
 
 You may find the audits for both AES-256-GCM and XChaCha20-Poly1305 on
 [the NCC Group's website](https://research.nccgroup.com/2020/02/26/public-report-rustcrypto-aes-gcm-and-chacha20poly1305-implementation-review/).
-
 ## Who uses volaris-crypto?
 
 This library is implemented by [volaris](https://github.com/volar-is/volaris), a secure multi-interface file encryption utility.
@@ -73,11 +72,7 @@ let decrypted_data = cipher.decrypt(&nonce, encrypted_data.as_slice()).unwrap();
 assert_eq!(secret, decrypted_data);
 ```
 
-You can read more about volaris, volaris-crypto and the technical details [in the project's main documentation](https://github.com/volar-is/volaris/)!
-
 ## Thank you!
 
-volaris-crypto exclusively uses AEADs provided by the
-[RustCrypto Team](https://github.com/RustCrypto), so I'd like to give them a
-huge thank you for their hard work (this wouldn't have been possible without
-them!)
+volaris-crypto uses AEADs provided by the [RustCrypto Team](https://github.com/RustCrypto)
+

crates/volaris-tools/README.md

@@ -1,6 +1,6 @@
  ## What is it?
 
- volaris-tools is a library used for managing the corecrypto logic behind volaris, and any applications that require easy integration with the volaris format.
+ volaris-tools is a library used for managing the core logic behind volaris, and any applications that require easy integration with the volaris format.
 
  ## Security
 
@@ -10,12 +10,7 @@
 
  ## Who uses Volaris-Tools?
 
- This library is implemented by [volaris](https://github.com/volar-is/volaris), a secure command-line file
+ This library is implemented by [volaris](https://github.com/volar-is/volaris), a secure file
  encryption utility.
 
  This crate was made to separate the logic away from the end-user application.
-
- It also allows for more things to be built on top of the corecrypto functionality, such as a GUI application.
-
-
- You can read more about volaris, volaris-crypto, volaris-tools and the technical details [in the project's main documentation](https://github.com/volar-is/volaris/)!