blob: 4004ec453a1a5369c09cc3e6bdfa54ae27831285 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
# Discovery
## Summary
Name: `Get Disco Servers` and `Get Disco Organizations`
Arguments: None
Returns: `structure for servers/organizations` and `Error for servers/organizations`
Note: Depending on the wrapper they may be combined into one function, the return value of this function is then the following:
`organizations, error for organizations, servers, errors for servers`
Used to obtain the servers and organizations list from the discovery server.
## Detailed information
Discovery is the aspect of eduVPN that allows a client to gather all the servers and organizations it can connect to. For this a discovery server is used, which is registered as `https://disco.eduvpn.org` in the library. We refer to the [official eduVPN documentation](https://github.com/eduvpn/documentation/blob/v3/SERVER_DISCOVERY.md) to learn more about the exact way that these organizations and servers are structured.
The data that this returns must be used by the client to build an UI. It is common for clients that the discovery functions get called on startup of the client. Note that there can be an error in retrieving the newest version of the servers/organizations. However, this library's goal is to ensure that a version is always available. Thus, a local copy is distributed with this library in the future.
This library also internally looks at the version of the servers and organizations such that rollbacks attacks are prevented. The client does not have to do any additional checks for this.
|
