Pengaturan keamanan API memungkinkan Anda mengelola Session ID, Pengaturan Validasi Skema, dan Konfigurasi Token untuk Edge Security Accelerator (ESA) API Security dari satu tempat. Identifier sesi terutama digunakan oleh fitur manajemen API, sedangkan konfigurasi token digunakan saat Anda mengonfigurasi aturan API.
Tambahkan identifier sesi
Identifier sesi mengidentifikasi sesi individual suatu API. ESA mengumpulkan dan menganalisis traffic API yang diberi tag serta menghasilkan saran pembatasan laju (rate limiting) untuk API tersebut.
Di konsol ESA, pilih Websites, lalu di kolom Website, klik situs target.
Di panel navigasi kiri, pilih Security > API Security.
Di halaman API Security, klik tab Settings, lalu klik Add pada bagian Session ID untuk memulai konfigurasi.

Pilih jenis identifier yang sesuai dengan kebutuhan bisnis Anda, lalu masukkan nama header kustom yang sesuai. Jenis identifier berikut tersedia:
Header
Cookie
JWT claims, yang harus sudah ada atau dibuat sekarang

Konfigurasikan validasi skema
Unggah skema API seperti spesifikasi OpenAPI. ESA secara otomatis mencocokkannya dengan API yang Anda kelola, memvalidasi permintaan masuk terhadap skema tersebut, dan menerapkan aksi yang dikonfigurasi pada permintaan yang tidak sesuai. Di pengaturan validasi skema, Anda dapat mengaktifkan atau menonaktifkan fitur ini, mengonfigurasi aksi default, dan mengunggah file skema kustom.
Di konsol ESA, pilih Websites, lalu di kolom Website, klik situs target.
Di panel navigasi kiri, pilih Security > API Security.
Di halaman API Security, klik tab Settings, lalu klik Configure pada bagian Schema Validation Settings untuk memulai konfigurasi.

Lengkapi pengaturan berikut berdasarkan kebutuhan bisnis Anda, lalu klik OK:
Status: Aktifkan atau nonaktifkan validasi skema.
Default Action: Pilih aksi default yang akan diterapkan pada permintaan yang tidak sesuai dengan skema. Aksi berikut tersedia:
Block: Memblokir permintaan yang tidak sesuai dan mencatat log blokir. Untuk melihat detailnya, lihat Event analysis.
Monitor: Mengizinkan permintaan yang tidak sesuai dan mencatat log. Untuk melihat detailnya, lihat Event analysis.
None: Tidak melakukan tindakan apa pun.
Uploaded Schema: Unggah file skema kustom. ESA mengurai file tersebut secara otomatis dan menggunakannya sebagai aturan validasi kepatuhan API.

Tambahkan token
Tambahkan informasi JSON Web Token (JWT) di Token Configuration, lalu rujuk di API token compliance validation untuk mengautentikasi pengunjung.
Di konsol ESA, pilih Websites, lalu di kolom Website, klik situs target.
Di panel navigasi kiri, pilih Security > API Security.
Di halaman API Security, klik tab Settings, lalu klik Add pada bagian Token Configuration untuk memulai konfigurasi.

Tentukan parameter token berikut berdasarkan kebutuhan bisnis Anda.
Name: Masukkan nama token kustom, seperti
JWT-Demo.Token Location: Pilih lokasi token dalam permintaan. Anda dapat memilih bidang Header atau Cookie, lalu masukkan kunci yang sesuai.
Untuk mengakomodasi JWT yang berada di lokasi berbeda di seluruh bisnis Anda, klik Or untuk membuat kondisi logis
OR. Anda dapat mengevaluasi hingga empat lokasi token secara bersamaan.Secret Key: Tambahkan kunci token dengan memasukkannya secara manual atau mengunggah file JSON. Untuk persyaratan kunci, lihat JWK fields.
Jika Anda mengonfigurasi beberapa kunci, ESA memilih kunci berdasarkan bidang
kiduntuk validasi. Validasi berhasil jika salah satu kunci berhasil memvalidasi token.
Spesifikasi file skema
Jenis dan ukuran
File validasi skema harus dalam format .yml, .yaml, atau .json. Ukuran maksimum file adalah 58 KB. Jika file skema Anda melebihi batas ini, gunakan format .json dan kompres file tersebut secara lokal sebelum mengunggah.
Konten skema
Versi
ESA validasi skema hanya mendukung OpenAPI Specification (OAS) v3.0.x.
Bidang
Bidang wajib
openapi: Versi API, seperti3.0.0.info: Metadata tentang API, seperti"version": "1.0.0".paths: Harus berisi setidaknya satu path API, seperti/api.servers: Informasi tentang host. Sub-bidang berikut didukung:url: Hanya URL absolut yang didukung, sepertihttps://api.example.com.variables: ESA tidak mendukung variabel server. Placeholder variabel diabaikan selama penguraian.
Bidang opsional
schema: Definisi struktur data. Jenis berikut didukung:int32
uint32
int64
uint64
float
double
boolean
email
reference: Menggunakan$refuntuk merujuk objek yang telah ditentukan. Referensi eksternal atau relatif tidak didukung.requestBody: Mendefinisikan badan permintaan. Hanya data dengancontent-typeapplication/jsonyang didukung.
Contoh
Berikut ini adalah contoh file skema .json.{
"openapi": "3.0.0",
"info": {
"title": "example",
"description": "example",
"version": "1.0"
},
"servers": [
{
"url": "https://example1.aliyun.com",
"description": "example1 url"
},
{
"url": "https://example2.aliyun.com",
"description": "example2 url"
}
],
"components": {
"schemas": {
"ParamsObject": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"value"
]
}
}
},
"paths": {
"/example/{param1}": {
"get": {
"operationId": "getexampleById",
"parameters": [
{
"name": "param1",
"in": "path",
"required": true,
"description": "id",
"schema": {
"type": "integer",
"format": "int32"
}
}
]
}
},
"/api1": {
"post": {
"operationId": "post_api1",
"summary": "post api1 request",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParamsObject"
}
}
}
}
},
"get" :{
"operationId": "get_api1",
"summary": "get api1 request",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
}
}
}Spesifikasi file skema
Jenis dan ukuran
File skema validasi harus berformat .yml, .yaml, atau .json. Ukuran maksimum file adalah 58 KB. Jika skema Anda melebihi batas ini, gunakan format .json dan kompres file tersebut secara lokal sebelum mengunggah.
Konten skema
Versi
ESA hanya mendukung OpenAPI Specification (OAS) v3.0.x untuk validasi skema.
Bidang
Bidang wajib
openapi: Versi API, misalnya3.0.0.info: Metadata API, seperti"version": "1.0.0".paths: Harus mencakup setidaknya satu path API, misalnya/api.servers: Informasi host. Sub-bidang berikut didukung:url: Hanya URL absolut yang didukung, misalnyahttps://api.example.com.variables: ESA tidak mendukung variabel server. Placeholder variabel diabaikan selama penguraian.
Bidang opsional
schema: Definisi struktur data. Jenis berikut didukung:int32
uint32
int64
uint64
float
double
boolean
email
reference: Gunakan$refuntuk merujuk objek yang telah ditentukan. Referensi eksternal atau relatif tidak didukung.requestBody: Mendefinisikan badan permintaan. Hanya data dengancontent-typeapplication/jsonyang didukung.
Contoh
Berikut contoh file skema .json.{
"openapi": "3.0.0",
"info": {
"title": "example",
"description": "example",
"version": "1.0"
},
"servers": [
{
"url": "https://example1.aliyun.com",
"description": "example1 url"
},
{
"url": "https://example2.aliyun.com",
"description": "example2 url"
}
],
"components": {
"schemas": {
"ParamsObject": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"value"
]
}
}
},
"paths": {
"/example/{param1}": {
"get": {
"operationId": "getexampleById",
"parameters": [
{
"name": "param1",
"in": "path",
"required": true,
"description": "id",
"schema": {
"type": "integer",
"format": "int32"
}
}
]
}
},
"/api1": {
"post": {
"operationId": "post_api1",
"summary": "post api1 request",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParamsObject"
}
}
}
}
},
"get" :{
"operationId": "get_api1",
"summary": "get api1 request",
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
}
}
}