Skip to content

Commit

Permalink
Merge branch 'main' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
wojcik91 authored Sep 18, 2023
2 parents bf797d8 + ce45776 commit 4d2b380
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,42 @@
<img src="docs/header.png" alt="defguard">
</p>

In a nutshell, from a **functionality** point defguard is an **OpenID Identity Provider** (SSO for your apps) and **Wireguard VPN Service** for building secure private networks (roadwarrior, mesh/peer-to-peer, site-to-site).
In a nutshell, from a functionality point defguard is an **OpenID Identity Provider (SSO for your apps with some unique features) and **Wireguard VPN Service Provider** for building secure private networks (roadwarrior, mesh/peer-to-peer, site-to-site).

On a broader aspect, it's a **security platform for building secure organizations**, addressing the most critical pain points and requirements to construct a privacy-aware, secure fundament for your users and systems. Read more about this in our [documentation](https://defguard.gitbook.io).
On a broader aspect, it's a **security platform for building secure and privacy-aware organizations** (with its secure architecture).

By design **defguard core is meant to be deployed in your secure network segments** (available only from an internal network or by VPN) and operations that require **public access** (like user onboarding, enrollment, password reset, etc.) are done using a **secure proxy**.

Read more about this in [our documentation](https://defguard.gitbook.io/defguard/#what-is-defguard).

**Implemented & production tested features:**

* [OpenID Connect provider](https://openid.net/developers/how-connect-works/)
* [OpenID Connect provider](https://openid.net/developers/how-connect-works/) - with **unique features**:
- Secure remote (over the internet) [user enrollment](https://defguard.gitbook.io/defguard/help/remote-user-enrollment)
- User [onboarding after enrollment](https://defguard.gitbook.io/defguard/help/remote-user-enrollment/user-onboarding-after-enrollment)
- LDAP (tested on [OpenLDAP](https://www.openldap.org/)) synchronization
- nice UI to manage users
- users can revoke access to granted apps
- OAuth2 of course...
- Users **self-service** (besides typical data management, users can revoke access to granted apps, MFA, Wireguard, etc.)
* [Wireguard:tm:](https://www.wireguard.com/) VPN management with:
- multiple VPN Locations (networks/sites) - with defined access (all users or only Admin group)
- multiple [Gateways](https://github.com/DefGuard/gateway) for each VPN Location (**high availability/failover**) - supported on a cluster of routers/firewalls for Linux, FreeBSD/PFSense/OPNSense
- import your current WireGuard server configuration (with a wizard!)
- *easy* device setup by users themselves (self-service)
- automatic IP allocation
- kernel (Linux, FreeBSD/OPNSense/PFSense) & userspace WireGuard support
- **import your current WireGuard server configuration (with a wizard!)**
- *in-development*: [Desktop Clients!](https://github.com/defguard/client)
- automatic IP allocation
- kernel (Linux, FreeBSD/OPNSense/PFSense) & userspace WireGuard support with [our Rust library](https://github.com/defguard/wireguard-rs)
- dashboard and statistics overview of connected users/devices for admins
- *defguard is not an official WireGuard project, and WireGuard is a registered trademark of Jason A. Donenfeld.*
* [Multi-Factor/2FA](https://en.wikipedia.org/wiki/Multi-factor_authentication) Authentication:
- [Time-based One-Time Password Algorithm](https://en.wikipedia.org/wiki/Time-based_one-time_password) (TOTP - e.g. Google Authenticator)
- WebAuthn / FIDO2 - for hardware key authentication support (eg. YubiKey, FaceID, TouchID, ...)
- Web3 - authentication with crypto software and hardware wallets using Metamask, Ledger Extension
* [Yubikey hardware keys](https://www.yubico.com/) provisioning for users by *one click*
* [Email/SMTP support](https://defguard.gitbook.io/defguard/help/setting-up-smtp-for-email-notifications) for notifications, remote enrollment and onboarding
* Easy support with [sending debug/support information](https://defguard.gitbook.io/defguard/help/sending-support-info)
* Webhooks & REST API
* Web3 wallet validation
* Build with [Rust](https://www.rust-lang.org/) for portability, security, and speed
* Fronted in TypeScript with:
* [UI Library](https://github.com/defguard/ui) - our beautiful React/TypeScript UI is a collection of React components:
- a set of custom and beautiful components for the layout
- Responsive Web Design (supporting mobile phones, tablets, etc..)
- [iOS Web App](https://www.macrumors.com/how-to/use-web-apps-iphone-ipad/)
Expand Down

0 comments on commit 4d2b380

Please sign in to comment.