Skip to content

Commit

Permalink
docs: adding missing configuration reference
Browse files Browse the repository at this point in the history
Added Application Security Policy
Added External Security Policy
Added Service Security Policy
  • Loading branch information
markmcdowell committed Dec 15, 2020
1 parent 3f46a3e commit 3b0555e
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Desktop

> **NOTE** pre v1 this is considered alpha/beta quality
> **NOTE** pre v1 this is considered beta quality
[![CircleCI](https://circleci.com/gh/reactivemarkets/desktop/tree/master.svg?style=shield)](https://circleci.com/gh/reactivemarkets/desktop/tree/master)
[![codecov](https://codecov.io/gh/reactivemarkets/desktop/branch/master/graph/badge.svg)](https://codecov.io/gh/reactivemarkets/desktop)
Expand Down
4 changes: 2 additions & 2 deletions docs/config/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Introduction
# Configuration

The configuration takes large design elements from [kubernetes](https://kubernetes.io/docs/reference/). If you're familar with kubernetes you'll recognise some similarities with the structure.

Everything is defined via configuration files, it is recommended to define your application in YAML. This is easier to read, maintain and allows you to group objects into a single file.

## Getting Started
## CLI

The [command line interface](/cli) allows you to create a basic configuration file in the current working directory:

Expand Down
34 changes: 34 additions & 0 deletions docs/config/applicationSecurityPolicy/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# Application Security Policy

Defines an Application Security Policy.

| Field | Type | Notes |
| ---------- | ---------------------------------------------------------- | -------------------------------------------------------------- |
| apiVersion | `string` | Optional api version for this object. |
| kind | `string` | Identifer for this configuration object. |
| metadata | [`Metadata`](../metadata) | Object metadata, see [metadata](../metadata). |
| spec | [`ApplicationSecurityPolicySpecification`](./#application-security-policy-specification) | See [Application Security Policy Specification](./#application-security-policy-specification). |

## Application Security Policy Specification

The specification for an application security policy.

| Field | Type | Notes |
| -------------- | ---------- | -------------------------------------------------------------- |
| allowedDomains | `string[]` | A list of regular expressions for allowed application domains. |
| blockedDomains | `string[]` | A list of regular expressions for blocked application domains. |

## Example

```yaml
---
kind: applicationSecurityPolicy
metadata:
name: Application Security Policy
description: Security Policy for desktop.
namespace: desktop
spec:
allowedDomains:
- ^https:\/\/.*$
blockedDomains:
- ^.*\.xxx$
```
34 changes: 34 additions & 0 deletions docs/config/externalSecurityPolicy/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# External Security Policy

Defines an External Security Policy.

| Field | Type | Notes |
| ---------- | ---------------------------------------------------------- | -------------------------------------------------------------- |
| apiVersion | `string` | Optional api version for this object. |
| kind | `string` | Identifer for this configuration object. |
| metadata | [`Metadata`](../metadata) | Object metadata, see [metadata](../metadata). |
| spec | [`ExternalSecurityPolicySpecification`](./#external-security-policy-specification) | See [External Security Policy Specification](./#external-security-policy-specification). |

## External Security Policy Specification

The specification for an external security policy.

| Field | Type | Notes |
| ------------------ | ---------- | ----------------------------------------------------- |
| allowedExecutables | `string[]` | A list of regular expressions for allowed executables. |
| blockedExecutables | `string[]` | A list of regular expressions for blocked executables. |

## Example

```yaml
---
kind: externalSecurityPolicy
metadata:
name: External Security Policy
description: Security Policy for desktop.
namespace: desktop
spec:
allowedExecutables:
- ^Calculator.exe$
blockedExecutables:
- ^.*$
```
32 changes: 32 additions & 0 deletions docs/config/serviceSecurityPolicy/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
# Service Security Policy

Defines a Service Security Policy.

| Field | Type | Notes |
| ---------- | ---------------------------------------------------------- | -------------------------------------------------------------- |
| apiVersion | `string` | Optional api version for this object. |
| kind | `string` | Identifer for this configuration object. |
| metadata | [`Metadata`](../metadata) | Object metadata, see [metadata](../metadata). |
| spec | [`ServiceSecurityPolicySpecification`](./#service-security-policy-specification) | See [Service Security Policy Specification](./#service-security-policy-specification). |

## Service Security Policy Specification

The specification for a Service security policy.

| Field | Type | Notes |
| ------------ | ---------- | -------------------------------------------------------- |
| allowedPaths | `string[]` | A list of regular expressions for allowed service paths. |
| blockedPaths | `string[]` | A list of regular expressions for blocked service paths. |

## Example

```yaml
---
kind: serviceSecurityPolicy
metadata:
name: Service Security Policy
description: Security Policy for desktop.
namespace: desktop
spec:
allowedPaths:
- ^.*$
```

0 comments on commit 3b0555e

Please sign in to comment.