diff --git a/.github/workflows/build-all-platforms.yml b/.github/workflows/build-all-platforms.yml new file mode 100644 index 0000000..009b78d --- /dev/null +++ b/.github/workflows/build-all-platforms.yml @@ -0,0 +1,61 @@ +name: Build All Platforms + +on: + push: + branches: [master] + workflow_dispatch: + +jobs: + build-tauri: + strategy: + fail-fast: false + matrix: + include: + - platform: "ubuntu-22.04" + args: "" + - platform: "macos-latest" + args: "--target aarch64-apple-darwin" + - platform: "macos-latest" + args: "--target x86_64-apple-darwin" + - platform: "windows-latest" + args: "" + + runs-on: ${{ matrix.platform }} + + steps: + - uses: actions/checkout@v4 + + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: "20" + cache: "npm" + + - name: Install Rust stable + uses: dtolnay/rust-toolchain@stable + with: + targets: ${{ matrix.platform == 'macos-latest' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }} + + - name: Install system dependencies (Linux) + if: matrix.platform == 'ubuntu-22.04' + run: | + sudo apt-get update + sudo apt-get install -y libwebkit2gtk-4.1-dev libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev + + - name: Install frontend dependencies + run: npm ci + + - name: Build frontend + run: npm run generate + + - name: Build Tauri app + uses: tauri-apps/tauri-action@v0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tagName: v__VERSION__ + releaseName: "this.ssh v__VERSION__" + releaseBody: "See the assets to download this version and install." + releaseDraft: false + prerelease: false + args: ${{ matrix.args }} diff --git a/.github/workflows/build-dev.yml b/.github/workflows/build-dev.yml new file mode 100644 index 0000000..b41f9e5 --- /dev/null +++ b/.github/workflows/build-dev.yml @@ -0,0 +1,38 @@ +name: Development Build + +on: + push: + branches: [develop] + pull_request: + branches: [master] + +jobs: + build: + runs-on: ubuntu-22.04 + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: "20" + cache: "npm" + + - name: Setup Rust + uses: dtolnay/rust-toolchain@stable + + - name: Install system dependencies + run: | + sudo apt-get update + sudo apt-get install -y libwebkit2gtk-4.1-dev libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev + + - name: Install dependencies + run: npm ci + + - name: Build frontend + run: npm run generate + + - name: Build Tauri app (debug) + run: npm run tauri:build:linux diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml new file mode 100644 index 0000000..7033be4 --- /dev/null +++ b/.github/workflows/update-readme.yml @@ -0,0 +1,57 @@ +name: Update README with releases + +on: + release: + types: [published] + workflow_dispatch: # allows manual run (for first-time setup) + +permissions: + contents: write + +jobs: + update-readme: + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v4 + + - name: Get all releases + id: releases + run: | + releases=$(curl -s https://api.github.com/repos/${{ github.repository }}/releases \ + | jq -r '.[] | "| " + .tag_name + " | " + .published_at[0:10] + " | [View Release](" + .html_url + ") |"' ) + echo "releases<> $GITHUB_ENV + echo "$releases" >> $GITHUB_ENV + echo "EOF" >> $GITHUB_ENV + + - name: Update README + run: | + # Build the markdown table with header + table="| Version | Date | Link |\n| ------- | ---- | ---- |\n$releases" + + awk -v repl="$table" ' + // { + print "" + print repl + next + } + // { + print "" + next + } + {print} + ' README.md > README.new + + mv README.new README.md + + - name: Commit changes + run: | + git config --global user.name "github-actions[bot]" + git config --global user.email "github-actions[bot]@users.noreply.github.com" + git add README.md + if git commit -m "chore: update README with releases"; then + git push + else + echo "No changes to commit" + fi diff --git a/.gitignore b/.gitignore index 01cc234..578ba2c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,25 +1,7 @@ -# Nuxt dev/build outputs -.output -.data -.nuxt -.nitro -.cache -dist - -# Node dependencies node_modules - -# Logs -logs -*.log -Documentation.md - -# Misc -.DS_Store -.fleet -.idea - -# Local env files -.env -.env.* -!.env.example +.nuxt +assets +components +src-tauri +.output/ +dist \ No newline at end of file diff --git a/Images/this-banner.png b/Images/this-banner.png new file mode 100644 index 0000000..3b0b73e Binary files /dev/null and b/Images/this-banner.png differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..874ba2b --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2025] [dh00mk3tu as Anirudh Rath] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 29c6b55..4817f2a 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,62 @@ -### Building From Source +# this.ssh -To build this.ssh from source, you will need to have the following libs installed: +![this.ssh Banner](https://github.com/dh00mk3tu/this.ssh/blob/main/Images/this-banner.png) -- Node.js (v22.0.0 or later) -- npm (v9.0.0 or later) -- TypeScript (v5.0.0 or later) -- Rust Compiler (v1.88.0 or later) -- Cargo (v1.88.0 or later) -- Tauri (v2.6.2, not tested on version v2.7.0 or later) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/dh00mk3tu/this.ssh) -Clone the repository: +### ๐Ÿš€ Releases -```bash -git clone git@github.com:dh00mk3tu/this.ssh.git -``` + -Navigate to the project directory: +| Version | Date | Link | +|:-------------|:------------------|:------| +| release-v1.0.0 | 2025-08-20 | [View Release](https://github.com/dh00mk3tu/this.ssh/releases/tag/release-v1.0.0) | -```bash -cd this.ssh -``` + -Change branch to `master`: -Master branch has the latest stable code. +### Simple SSH Management Tool -```bash -git checkout master -``` +`main` branch is used for the intro, setup guide and LICENCE information. -Install the dependencies: +| Section | Description | +| --------------------------------------------------------------------------------- | ------------------------------------------------- | +| [Project Overview](#project-overview) | Overview of the project and its purpose | +| [Features - Roadmap](#features---roadmap) | List of features and future plans | +| [Installation](#installation) | Instructions on how to install the project | +| [Development Setup](https://github.com/dh00mk3tu/this.ssh/wiki/Development-Setup) | Instructions for building the project from source | -```bash -npm install -``` +### Project Overview -Build the project: +It was a regular summer afternoon and I found myself in a predcament situation. +I was setting up my work repository and for that I had to setup a SSH key to be able to push my code to the remote work repository. +Now, though the process of setting up a SSH key is quite simple, and has been document so many times, it wasn't really an issue; I've done it before countless times but I still had to check the documentation just in case because I always forget the exact commands to use since it happens not that regularly. -```bash -npm run tauri build -``` +This wasn't the actual problem though; I already had my personal SSH key setup and now I had another that was associated with work, both were loaded in my SSH agent and I had to switch between them all the time. After a while I was annoyed with it that I have to switch between the SSH keys, remember the exact commands to use, or visit some documentation/GPT to get the commands right. -#### Running the Project Locally +I though to myself, "There must be a better way to manage SSH keys and connections", the asnwer was to use a config file but I didn't find it elegant enough for my needs. I wanted something that would allow me to easily add, remove, and list SSH hosts without having to manually edit a config file or remember the exact commands. -To run and to test the project locally, you need to run both the Tauri and the NUXT development servers. -Ideally I run one terminal and split it into two panes, one for each server (tmux), or tabs. +Hence, `this.ssh` was born. -Start the Tauri development server: +`this.ssh` is a simple SSH management tool that allows users to manage their SSH connections and configurations easily. It provides a user-friendly interface for adding, removing, and listing SSH hosts. -```bash -cargo tauri dev -``` +### Features - Roadmap -Start the NUXT development server: +| Features - Complete | Release Date | +| ---------------------------------- | ------------ | +| List SSH Keys | 30/07/2025 | +| Onload SSH Keys into the SSH agent | 30/07/2025 | +| Create SSH Keys | 13/08/2025 | +| Remove SSH Keys | 19/08/2025 | +| Documentation - Initial Phase | 19/08/2025 | -```bash -npm run dev -``` +--- -The application will fire a native window and the application will work within that window only. The application will not work in a browser, it is a native application amd Tauri APIs do not work in a browser environment. +| Features - Inprogress | Release Date | +| ----------------------------------- | ------------ | +| Offload SSH Keys into the SSH agent | TBR | +| Create User/User Auth | TBR | +| Save your keys to the cloud | TBR | -## Features +### Installation -### SSH Key Management - -- **View SSH Keys**: Scan and display all SSH keys in your `~/.ssh/` directory -- **SSH Agent Integration**: Show which keys are currently loaded in your SSH agent -- **Key Status**: Display whether each key is active (loaded) or inactive -- **Copy Public Keys**: Copy public key content to clipboard for easy sharing - -### SSH Key Creation - -- **Create New Keys**: Generate new SSH keys directly from the application -- **Multiple Key Types**: Support for RSA, Ed25519, and ECDSA key types -- **Configurable Key Sizes**: - - RSA: 2048 or 4096 bits - - ECDSA: 256, 384, or 521 bits - - Ed25519: 256 bits (fixed) -- **Optional Passphrase**: Add passphrase protection to your keys -- **Smart Naming**: Automatic filename generation based on key type and email - -### Key Types Supported - -- **RSA**: Traditional RSA keys with configurable bit lengths -- **Ed25519**: Modern, secure keys (recommended for new deployments) -- **ECDSA**: Elliptic curve keys with various curve sizes +Installation guide Will be updated soon once the first release is out. diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..2e3501a --- /dev/null +++ b/_config.yml @@ -0,0 +1,7 @@ +remote_theme: pages-themes/cayman@v0.2.0 +plugins: + - jekyll-remote-theme + +title: this.ssh +description: The simple SSH management tool +show_downloads: true diff --git a/build-mac.sh b/build-mac.sh index 5822215..1b4e63b 100755 --- a/build-mac.sh +++ b/build-mac.sh @@ -30,6 +30,12 @@ npm install echo "๐Ÿ”จ Building Nuxt.js frontend..." npm run generate +# Clean Rust build cache to avoid objc2-exception-helper issues +echo "๐Ÿงน Cleaning Rust build cache..." +cd src-tauri +cargo clean +cd .. + # Check if dist directory exists and contains index.html if [ ! -f "dist/index.html" ]; then echo "โŒ Error: dist/index.html not found. Frontend build failed." diff --git a/src-tauri/Cargo.toml b/src-tauri/Cargo.toml index 976f9af..6db6277 100644 --- a/src-tauri/Cargo.toml +++ b/src-tauri/Cargo.toml @@ -15,13 +15,13 @@ name = "app_lib" crate-type = ["staticlib", "cdylib", "rlib"] [build-dependencies] -tauri-build = { version = "2.3.0", features = [] } +tauri-build = { version = "2.0.0", features = [] } [dependencies] serde_json = "1.0" serde = { version = "1.0", features = ["derive"] } log = "0.4" -tauri = { version = "2.6.2", features = [] } -tauri-plugin-log = "2" +tauri = { version = "2.0.0", features = [] } +tauri-plugin-log = "2.0.0" dirs = "5.0" ssh-key = "0.6.7"