Skip to content

hlhr202/Openconnect-RS

Repository files navigation

OpenConnect for Rust

GitHub License Crates.io Version GitHub Release

GitHub Actions Workflow Status GitHub Actions Workflow Status GitHub Actions Workflow Status

This is a cross-platform GUI client for OpenConnect, written in Rust and designed to work seamlessly on Windows, Linux, and macOS desktop systems. The program utilizes various technologies including MSYS2, Tauri, React, and NextUI. It provides a user-friendly interface for connecting to VPN servers using both password and OIDC authentication methods.

Features

  • Cross-platform compatibility (Windows, Linux, macOS)
  • Easy-to-use GUI interface
  • Support for both password and OIDC authentication
  • Built with MSYS2, Tauri, React, and NextUI

Screenshots

Main

Edit

Connect

Installation of Client

  • GUI:

    • Supports Windows(x64), Linux(x64), and macOS(aarch64, x64)

    • Download can be found in Releases

  • CLI install:

    • Only supports Linux(x64) and macOS(aarch64, x64)

    • Run the following command in your terminal:

      curl -sL https://raw.githubusercontent.com/hlhr202/Openconnect-RS/main/install-cli.sh | sh

Usage of CLI client

  • Run the following command in your terminal:

    openconnect --help

    This will print the following help message:

    A CLI client to connect to VPN using OpenConnect
    
    Usage: openconnect <COMMAND>
    
    Commands:
      start   Connect to a VPN server and run in daemon mode [aliases: connect, run]
      status  Get the current VPN connection status [aliases: info, stat]
      stop    Close the current connection and exit the daemon process [aliases: kill, disconnect]
      add     Add new VPN server configuration to local config file [aliases: new, create, insert]
      delete  Delete a VPN server configuration from local config file [aliases: rm, remove, del]
      list    List all VPN server configurations in local config file [aliases: ls, l]
      logs    Show logs of the daemon process [aliases: log]
      help    Print this message or the help of the given subcommand(s)
    
    Options:
      -h, --help     Print help
      -V, --version  Print version
    
  • For each subcommand, you can run openconnect <COMMAND> --help to get more information

    For example:

    openconnect start --help

    This will print the following help message:

    Connect to a VPN server and run in daemon mode
    
    Usage: openconnect start [OPTIONS] <NAME>
    
    Arguments:
      <NAME>  The server name saved in local config file to connect to
    
    Options:
      -c, --config-file <CONFIG_FILE>  The path to the local config file
      -h, --help                       Print help
    

Build

  • Read the System Requirements for environment setup
  • Modify it to fit your environment (For automatic setup, its WIP)
  • For windows, since openconnect provides GNU automake, we currently only support MSYS2-MINGW64 and x86_64-pc-windows-gnu toolchain
    • Install MSYS2
    • Install x86_64-pc-windows-gnu toolchain with command rustup default stable-x86_64-pc-windows-gnu
    • Run cargo under MINGW64 shell

License

This project is licensed under the GNU Lesser General Public License (LGPL). See the LICENSE file for details.

Acknowledgements

Special thanks to (MORE THAN) the following projects and technologies for making this project possible:

Roadmap

Openconnect sys

  • Automatically build openconnect
  • Automatically search library path
    • Optimize search path for more cases

Openconnect core

  • implement safe ffi
  • implement password login
  • implement cookie login
  • implement ssl certificate validation
  • implement public key login

Client

  • implement password login
  • implement oidc login
  • implement logs
    • tracing file rotation
  • implement CLI
    • Add/Remove configurations
    • Daemon mode
    • Password login
    • OIDC login