Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add posture checks doc #144

Merged
merged 10 commits into from
Feb 22, 2024
1 change: 1 addition & 0 deletions src/components/NavigationDocs.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export const docsNavigation = [
{ title: 'CLI', href: '/how-to/cli' },
{ title: 'Delete your NetBird account', href: '/how-to/delete-account' },
{ title: 'IdP sync', href: '/how-to/idp-sync' },
{ title: 'posture checks', href: '/how-to/posture-checks' },
mlsmaycon marked this conversation as resolved.
Show resolved Hide resolved
{ title: 'Report bugs and issues', href: '/how-to/report-bug-issues' },
{ title: 'Troubleshooting client issues', href: '/how-to/troubleshooting-client' },
],
Expand Down
37 changes: 37 additions & 0 deletions src/pages/how-to/posture-checks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Introduction

NetBird enables administrators to manage resource access through the creation of access policies, dictating which peer
groups can interact. Posture checks serve as an extension to these policies, augmenting their capabilities by allowing
administrators to enforce access restrictions based on specified criteria. By integrating posture checks seamlessly into
policy-based ACLs, NetBird evaluates various attributes to determine the eligibility of peers to connect to the network.


## Concepts

### NB Version Check

The NB Version check verifies the version of NetBird installed on the device attempting to connect to the network.
This check ensures that only devices running a specified version of NetBird can gain access, thus preventing outdated or
incompatible clients from compromising network security.

### OS Version Check

The OS Version check evaluates the operating system (OS) version running on the connecting device.
This check allows for the enforcement of minimum OS requirements, ensuring that only devices with up-to-date and secure
operating systems can access network resources.

The check evaluates the actual OS version for Android, Darwin, and iOS, while for Linux and Windows, it assesses the
kernel version.

### Geo Check

The Geo Check examines the geographical location of the connecting device based on its connection IP address.
This check allows administrators to enforce access restrictions based on geographic regions.


## Managing Posture Checks

### Creating posture check
### Adding posture check to policy
### Update posture check
### Delete posture check
Loading