-
-
Notifications
You must be signed in to change notification settings - Fork 681
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: adding document for servers' security (#2231)
Co-authored-by: Alejandra Quetzalli <[email protected]>%0ACo-authored-by: Lukasz Gornicki <[email protected]>
- Loading branch information
Showing
1 changed file
with
115 additions
and
0 deletions.
There are no files selected for viewing
115 changes: 115 additions & 0 deletions
115
pages/docs/concepts/asyncapi-document/server-security.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
--- | ||
title: Server Security | ||
weight: 200 | ||
--- | ||
|
||
Server security refers to the measures and practices implemented to protect servers from unauthorized access, data breaches, and other security threats. Server security involves implementing various security mechanisms to ensure the confidentiality, integrity, and availability of server resources. | ||
|
||
In the context of AsyncAPI, securing servers ensures secure exchange of messages between clients and servers. While also protecting sensitive data, preventing unauthorized access, and maintaining the overall security of the API or server. | ||
|
||
You can describe how is your server secured with `security` property where you define which security schemes can be used with the server in context. Each `server` in the AsyncAPI document can have one or more security schemes declared. A security scheme defines a security requirement that must be satisfied to authorize an operation, such as a API key or username and password. | ||
|
||
Here is a example of adding security to your server that shows that different server can have different security mechanisms: | ||
```yml | ||
asyncapi: 3.0.0 | ||
info: | ||
title: Streetlights Kafka API | ||
version: 1.0.0 | ||
servers: | ||
scram-connections: | ||
host: 'test.mykafkacluster.org:18092' | ||
protocol: kafka-secure | ||
description: Test broker secured with scramSha256 | ||
security: | ||
- $ref: '#/components/securitySchemes/saslScram' | ||
mtls-connections: | ||
host: 'test.mykafkacluster.org:28092' | ||
protocol: kafka-secure | ||
description: Test broker secured with X509 | ||
security: | ||
- $ref: '#/components/securitySchemes/certs' | ||
components: | ||
securitySchemes: | ||
saslScram: | ||
type: scramSha256 | ||
description: Provide your username and password for SASL/SCRAM authentication | ||
certs: | ||
type: X509 | ||
description: Download the certificate files from service provider | ||
``` | ||
Here is a illustration of securing servers: | ||
```mermaid | ||
graph LR | ||
C[servers] | ||
F[host] | ||
I[protocol] | ||
E[security] | ||
C --> F | ||
C --> E | ||
C --> I | ||
style C fill:#47BCEE,stroke:#000; | ||
style E fill:#47BCEE,stroke:#000 | ||
``` | ||
|
||
Here are some of the security schemes that AsyncAPI supports: | ||
- User/Password | ||
```yml | ||
type: userPassword | ||
``` | ||
- API key (either as a user or as a password) | ||
```yml | ||
type: apiKey | ||
in: user | ||
``` | ||
- X.509 certificate | ||
```yml | ||
type: X509 | ||
``` | ||
- End-to-end encryption (either symmetric or asymmetric) | ||
```yml | ||
type: symmetricEncryption | ||
``` | ||
- HTTP authentication | ||
```yml | ||
type: http | ||
scheme: basic | ||
``` | ||
- HTTP API key | ||
```yml | ||
type: httpApiKey | ||
name: api_key | ||
in: header | ||
``` | ||
- JWT Bearer | ||
```yml | ||
type: http | ||
scheme: bearer | ||
bearerFormat: JWT | ||
``` | ||
- Implicit oauth2 | ||
```yml | ||
type: oauth2 | ||
flows: | ||
implicit: | ||
authorizationUrl: https://example.com/api/oauth/dialog | ||
availableScopes: | ||
write:pets: modify pets in your account | ||
read:pets: read your pets | ||
scopes: | ||
- 'write:pets' | ||
``` | ||
- SASL (Simple Authentication and Security Layer) as defined in RFC4422 | ||
```yml | ||
type: scramSha512 | ||
``` | ||
Although, the `security` property is not mandatory to be implemented, it is a good practise to always secure your server(s) in production. Similarly, having multiple security schemes declared does not necessarily mean that the server is more secure, it really depends on other factors such as the protocol used, use case, business perspective and more. Additionally, you can also [add security on the `operation` level](securing-operations) |