-
-
Notifications
You must be signed in to change notification settings - Fork 681
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: adding document for servers' security #2231
Changes from all commits
d4ac709
981586e
0e2c4d6
f514198
34f8c62
f175921
4265bba
9c5a07d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
Here is a example of adding security to your server that shows that different server can have different security mechanisms: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
```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: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
```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) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.