Skip to content
This repository was archived by the owner on Mar 8, 2024. It is now read-only.

Commit ec22205

Browse files
Dino RodriguezAustin King
andauthored
docs: private api security (#498)
* docs: TLS requirement in docs * docs: private api security * Update readme.md Co-authored-by: Austin King <aking@ripple.com> * docs: must fix Co-authored-by: Austin King <aking@ripple.com>
1 parent b38a2a4 commit ec22205

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,20 @@
1414

1515
## Required Server Security
1616

17-
There are a few critical security measures that **MUST** be taken when running this PayID server implementation.
17+
Here are several critical security measures you MUST implement when running this PayID server implementation:
1818

19-
### TLS
19+
### TLS (Transport Layer Security)
2020

2121
TLS is a **requirement** for PayID. This PayID server implementation does not include TLS out-of-the-box, so it must be configured.
2222

2323
For instructions on configuring TLS with an NGINX reverse proxy for PayID, go [here](https://dev.docs.payid.org/docs/remote-deployment#nginx-reverse-proxy--ssl-setup).
2424

2525
For PayID security best practices, go [here](https://dev.docs.payid.org/docs/payid-best-practices).
2626

27+
### Private API
28+
29+
The Private API does not currently include authentication. Therefore, this API MUST only be exposed to trusted IP ranges, and MUST NOT be exposed publicly.
30+
2731
## 4. PayID integration and the PayID APIs
2832

2933
You can deploy your own PayID server and then create PayIDs for your users using the PayID Private API. You can also query and modify this list of users. This API should be exposed internally only, so that only your company's systems can update PayID mappings.

0 commit comments

Comments
 (0)