You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-18
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
-
# Endpoint Server (EPS)
1
+
# Hyper
2
2
3
-
This repository contains the code of the IRIS connect endpoint server (EPS), which manages the communication between different actors in the IRIS connect ecosystem. It provides a gRPC server & client to exchange messages between different actors (`eps`), a service directory (`sd`) that provides a public registry of signed information about actors, and a TLS passthrough proxy (`proxy`) that enables actors to directly receive data from users via TLS.
3
+
This repository contains the code of the Hyper mesh router & overlay network system, which provides a programmable network & communication layer for distributed systems. It provides a gRPC server & client to exchange messages between different actors (`hyper`), a service directory (`sd`) that provides a public registry of signed information about actors in the system, and a TLS passthrough proxy (`proxy`) that enables actors to directly receive data from each other and third-parties via TLS.
4
4
5
-
Please also check out the [documentation](https://iris-connect.github.io/eps/docs/) for more detailed information. Please check the `docs` subfolder for instructions on how to build/view the documentation locally.
5
+
Please also check out the [documentation](https://kiprotect.github.io/hyper/docs/) for more detailed information. Please check the `docs` subfolder for instructions on how to build/view the documentation locally.
6
6
7
7
## Getting Started
8
8
9
9
Please ensure your Golang version is recent enough (>=1.13) before you attempt to build the software.
10
10
11
-
To build the `eps`, `sd` and `proxy` binaries, simply run
11
+
To build the `hyper`, `sd` and `proxy` binaries, simply run
12
12
13
13
```bash
14
14
make
@@ -24,19 +24,19 @@ Please note that you need `openssl` on your system for this to work. This will g
24
24
25
25
Please see below for additional dependencies you might need to install for various purposes (e.g. to recompile protobuf code).
26
26
27
-
To build the example services (e.g. the "locations" services `eps-ls`) simply run
27
+
To build the example services (e.g. the "locations" services `hyper-ls`) simply run
28
28
29
29
```bash
30
30
make examples
31
31
```
32
32
33
33
## Defining Settings
34
34
35
-
The `eps` binary will look for settings in a list of colon (`:`) separated directories as defined by the `EPS_SETTINGS` environment variable (or, if it is undefined in the `settings` subdirectory of the current directory). The development settings include an environment-based variable `EPS_OP` that allows you to use different certificates for testing. You should define these variables before running the development server:
35
+
The `hyper` binary will look for settings in a list of colon (`:`) separated directories as defined by the `HYPER_SETTINGS` environment variable (or, if it is undefined in the `settings` subdirectory of the current directory). The development settings include an environment-based variable `HYPER_OP` that allows you to use different certificates for testing. You should define these variables before running the development server:
36
36
37
37
```bash
38
-
exportEPS_SETTINGS=`readlink -f settings/dev`
39
-
exportEPS_OP=hd-1 # run server as the 'hd-1' operator
38
+
exportHYPER_SETTINGS=`readlink -f settings/dev`
39
+
exportHYPER_OP=hd-1 # run server as the 'hd-1' operator
40
40
```
41
41
42
42
You can also source these things from the local `.dev-setup` script, which includes everything you need to get started:
@@ -45,13 +45,13 @@ You can also source these things from the local `.dev-setup` script, which inclu
45
45
source .dev-setup # load all development environment variables
46
46
```
47
47
48
-
There are also role-specific development/test settings in the `settings/dev/roles` directory. Those can be used to set up multiple EPS servers and test the communication between them. Please have a a look at the [integration guidelines](docs/integration.md) for more information about this.
48
+
There are also role-specific development/test settings in the `settings/dev/roles` directory. Those can be used to set up multiple Hyper servers and test the communication between them. Please have a a look at the [integration guidelines](docs/integration.md) for more information about this.
49
49
50
50
**Important: The settings parser includes support for variable replacement and many other things. But with great power comes great responsibility and attack surface, so make sure you only feed trusted YAML input to it, as it is not designed to handle untrusted or potentially malicious settings.**
51
51
52
52
## Running The Service Directory
53
53
54
-
All EPS servers rely on the service directory (SD) to discover each other and learn about permissions, certificates and other important settings. For development, you can either use a JSON-based service directory, or run the service directory API like this:
54
+
All Hyper servers rely on the service directory (SD) to discover each other and learn about permissions, certificates and other important settings. For development, you can either use a JSON-based service directory, or run the service directory API like this:
55
55
56
56
```bash
57
57
SD_SETTINGS=settings/dev/roles/sd-1 sd run
@@ -68,15 +68,15 @@ make sd-test-setup
68
68
69
69
This should give you a fully functional API-based service directory with certificate and service information.
70
70
71
-
## Running The EPS Server
71
+
## Running The Hyper Server
72
72
73
-
To run the development EPS server simply run (from the main directory)
73
+
To run the development Hyper server simply run (from the main directory)
74
74
75
75
```bash
76
-
EPS_SETTINGS=settings/dev/roles/hd-1 eps server run
76
+
HYPER_SETTINGS=settings/dev/roles/hd-1 hyper server run
77
77
```
78
78
79
-
This will run the EPS server for the role `hd-1` (simulating a health department in the system). For this to work you need to ensure that your `GOPATH` is in your `PATH`. This will open the JSON RPC server and (depending on the settings) also a gRPC server.
79
+
This will run the Hyper server for the role `hd-1` (simulating a health department in the system). For this to work you need to ensure that your `GOPATH` is in your `PATH`. This will open the JSON RPC server and (depending on the settings) also a gRPC server.
80
80
81
81
## Running The Proxy Servers
82
82
@@ -136,16 +136,16 @@ To generate TLS certificates for testing and development you need to have `opens
136
136
137
137
## Deployment
138
138
139
-
You can easily deploy the server as a service using `systemd` or Docke. Specific documentation coming up soon.
139
+
You can easily deploy the server as a service using `systemd` or Docker. Specific documentation coming up soon.
140
140
141
141
# Feedback
142
142
143
-
If you have any questions [just contact us](mailto:[email protected]).
143
+
If you have any questions [just contact us](mailto:[email protected]).
144
144
145
145
# Participation
146
146
147
-
We are happy about your contribution to the project! In order to ensure compliance with the licensing conditions and the future development of the project, we require a signed contributor license agreement (CLA) for all contributions in accordance with the [Harmony standard](http://selector.harmonyagreements.org). Please sign the corresponding document for [natural persons](.clas/iris-connect-individual.pdf) or for [organizations](.clas/iris-connect-entity.pdf) and send it to [us](mailto:[email protected]).
147
+
We are happy about your contribution to the project! In order to ensure compliance with the licensing conditions and the future development of the project, we require a signed contributor license agreement (CLA) for all contributions in accordance with the [Harmony standard](http://selector.harmonyagreements.org). Please sign the corresponding document for [natural persons](.clas/hyper-individual.pdf) or for [organizations](.clas/hyper-entity.pdf) and send it to [us](mailto:[email protected]).
148
148
149
149
## Supporting organizations
150
150
151
-
- Björn Steiger Stiftung SbR - https://www.steiger-stiftung.de
151
+
-The software on which Hyper is based, originally named EPS (Endpoint System), was generously suppored by the Björn Steiger Stiftung SbR - https://www.steiger-stiftung.de. The source code of the system is available at https://github.com/iris-connect/eps.
If you want to report a bug which is not security sensible, please submit an issue.
11
10
12
11
## Reporting a Security Issue
13
-
Our team takes all security issues in IRIS seriously.
14
-
If you want to report a security issue we appreciate your effort and kindly ask you to submit a responsible disclosure.
15
-
Unfortunately, IRIS does not offer a bug bounty programme or other forms of monetary compensation yet.
16
-
However, we plan to join a bug bounty platform like HackerOne in the long-term.
17
-
Also, we can acknowledge your effort publicly in the GitHub project.
18
-
Thank you for improving the security of the IRIS project!
19
12
20
-
Report security issues via email at [security@iris-connect.de](mailto:[email protected]?subject=GitHub%20Security%20Issue%20EPS).
13
+
Our team takes all security issues in Hyper seriously. If you want to report a security issue we appreciate your effort and kindly ask you to submit a responsible disclosure. Hyper does not offer a bug bounty programme or other forms of monetary compensation yet. Also, we can acknowledge your effort publicly in the GitHub project. Thank you for improving the security of the Hyper project!
21
14
22
-
The IRIS team acknowledges your email within 24 hours and will further respond in detail within 48 hours, explaining the induced actions.
The Hyper team will try to acknowledge your email within 24 hours and will further respond in detail within 48 hours, explaining the induced actions.
23
18
Our security team will keep you up to date of the progress towards fixing the vulnerability and may ask you for additional information.
24
19
25
-
Please report security issues in third-party dependencies to the person or team maintaining
26
-
the project for this dependency.
20
+
Please report security issues in third-party dependencies to the person or team maintaining the project for this dependency.
21
+
22
+
Please note that we will ignore **beg bounties**, i.e. vague e-mails asking for compensation in exchange for disclosing a security issue.
27
23
28
24
## Responsible Disclosure Policy
29
25
30
-
When we receive a security bug report, we will assign it to a person who handles your disclosure.
31
-
This person is responsible for the following steps of the fix process:
26
+
When we receive a security bug report, we will assign it to a person who handles your disclosure. This person is responsible for the following steps of the fix process:
32
27
33
28
* Confirm the problem and identify affected versions
0 commit comments