APIを使用してAPIセキュリティを管理する
APIセキュリティを作成、構成、および展開するために、APIにアクセスできます。
注:
この機能を構成するためにAPIセキュリティAPIを使用する方法を理解するには、Nitro APIドキュメントを参照してください。
| 手順 | リソースURL | |
|---|---|---|
| 1 | API定義を作成する | https://adm.cloud.com/{customerid}/apisec/nitro/v1/config/apidefs |
| 2 | APIプロキシを追加する | https://adm.cloud.com/apiproxies |
| 3 | APIプロキシを使用してAPIインスタンスを展開する | https://adm.cloud.com/apiproxies/{customerid}/deployments |
| 4 | APIポリシーを追加する | https://adm.cloud.com/{customerid}/apisec/nitro/v1/config/policies/{id} |
各APIポリシーには異なる
config_specオブジェクトがあります。これは、特定の値を持つpolicytypeを構成するためのJSON辞書を含む不透明なオブジェクトです。
このオブジェクトでは、以下のオプションを使用してAPIリソースとそのメソッドを選択できます。
-
api-resource-paths- API定義で定義されているAPIリソースのパスとメソッドを指定します。例：{
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": false,
"put": false,
"delete": false
} -
custom-rules- API定義に存在しない可能性があるカスタムAPIリソースのパスとメソッドを指定します。例：{
"endpoints": ["/pet/categories", "/pet/findByName"],
"get": true,
"post": false,
"put": false,
"delete": false
}
この構成により、ポリシーは指定されたAPIリソースパスに一致する受信トラフィックリクエストをフィルタリングします。
各ポリシータイプの
config_specに関する情報については、ポリシータイプのAPI例を参照してください。
ポリシータイプのAPI例
このセクションでは、サポートされているAPIポリシータイプとその構成について説明します。
レート制限
Ratelimitポリシータイプの構成例を次に示します。config_specオブジェクトに次の構成を指定します。
{
"policytype": "Ratelimit",
"config_spec": {
"api-resource-paths": {
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": false,
"put": false,
"delete": false
},
"custom-rules": {},
"threshold": "10",
"timeslice": "20000",
"limittype": "BURSTY",
"api-respondertype": "DROP",
"header_name": "x-api-key",
"per_client_ip": true
},
"order_index": 1,
"policy_name": "ratelimit_policy"
}
各属性の詳細については、レート制限ポリシーを参照してください。
オース
JWT Auth validationポリシータイプのAPI構成例を次に示します。config_specオブジェクトに次の構成を指定します。
{
"policytype": "JWT Auth Validation",
"config_spec": {
"api-resource-paths": {
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": true,
"put": false,
"delete": false
},
"custom-rules": {},
"jwks-uri": "https://uri.petstore.com",
"issuer": "https://issuer.petstore.com",
"audience": "petstore",
"introspect-uri": "https://introspect.uri.com",
"clientid": "client",
"clientsecret": "clientsecret",
"claims-to-save": ["scope", "scope2"],
"allowed-algorithms": {
"hs256": true,
"rs256": true,
"rs512": true
}
},
"order_index": 2,
"policy_name": "Jwt_auth_policy"
}
各属性の詳細については、OAuthポリシーを参照してください。
基本認証
BasicAuthポリシータイプのAPI設定例を次に示します。
{
"config_spec": {
"api-resource-paths": {
"delete": false,
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": true,
"put": false
},
"custom-rules": {}
},
"order_index": 3,
"policy_name": "Auth_BaSIC",
"policytype": "BasicAuth"
}
各属性の詳細については、基本認証ポリシーを参照してください。
認証なし
NoAuthポリシータイプのAPI設定例を次に示します。
{
"config_spec": {
"api-resource-paths": {
"delete": false,
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": false,
"put": false
},
"custom-rules": {}
},
"order_index": 4,
"policy_name": "no_auth_policy",
"policytype": "NoAuth"
}
ボット
BotポリシータイプのAPI設定例を次に示します。
{
"config_spec": {
"api-resource-paths": {
"delete": false,
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": false,
"post": false,
"put": false
},
"bot-prof-name": "apisec_test_profile",
"custom-rules": {}
},
"order_index": 5,
"policy_name": "bot_policy",
"policytype": "Bot"
}
各属性の詳細については、ボットポリシーを参照してください。
WAF
WAFポリシータイプのAPI設定例を次に示します。
{
"config_spec": {
"api-resource-paths": {
"delete": false,
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": false,
"post": false,
"put": false
},
"waf-prof-name": "apisec_waf_profile",
"custom-rules": {}
},
"order_index": 6,
"policy_name": "waf_policy",
"policytype": "WAF"
}
各属性の詳細については、WAFポリシーを参照してください。
ヘッダー書き換え
ヘッダー書き換えポリシータイプのAPI設定例を次に示します。この設定は
config_specオブジェクトで指定します。
{
"policytype": "Header Rewrite",
"config_spec": {
"api-resource-paths": {
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": true,
"put": false,
"delete": false
},
"custom-rules": {},
"rewrite-policy-header-field-name": "org",
"rewrite-policy-header-field-val": "Citrix",
"rewrite-policy-header-field-new-val": "Citrite"
},
"order_index": 7,
"policy_name": "header_rewrite_pol"
}
各属性の詳細については、ヘッダー書き換えポリシーを参照してください。
URIパス書き換え
URIパス書き換えポリシータイプのAPI設定例を次に示します。
{
"config_spec": {
"api-resource-paths": {
"endpoints": ["/store/order", "/store/inventory"],
"delete": false,
"get": true,
"post": true,
"patch": false,
"put": false
},
"custom-rules": {
"delete": false,
"endpoints": [],
"get": false,
"post": false,
"patch": false,
"put": true
},
"path-rewrite-params": [
{
"insert-segment-position": "beginning",
"new-path-value": "v3",
"old-path-value": "v2",
"action-type": "replace path segment"
},
{
"insert-segment-position": "beginning",
"new-path-value": "begin",
"action-type": "insert path segment"
},
{
"insert-segment-position": "end",
"new-path-value": "end",
"action-type": "insert path segment"
},
{
"insert-segment-position": "before",
"new-path-value": "before",
"old-path-value": "store",
"action-type": "insert path segment"
},
{
"insert-segment-position": "after",
"new-path-value": "after",
"old-path-value": "store",
"action-type": "insert path segment"
}
]
},
"order_index": 24,
"policy_name": "eats_uripathrewrite",
"policytype": "URI Path Rewrite”
}
各属性の詳細については、URI Path Rewrite policyを参照してください。
認証
以下は、
AuthorizationポリシータイプのAPI構成例です。config_specオブジェクトに以下の構成を指定します。
{
"policytype": "Authorization",
"config_spec": {
"api-resource-paths": {
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": true,
"put": false,
"delete": false
},
"custom-rules": {},
"claims": [{
"name": "scope",
"values": ["value1", "value2"]
}]
},
"order_index": 8,
"policy_name": "authorization"
}
各属性の詳細については、Authorization policyを参照してください。
拒否
以下は、
DenyポリシータイプのAPI構成例です。config_specオブジェクトに以下の構成を指定します。
{
"policytype": "Deny",
"config_spec": {
"api-resource-paths": {
"endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
"get": true,
"post": true,
"put": false,
"delete": false
},
"custom-rules": {},
"api-denytype": "RESPONDWITH"
},
"order_index": 9,
"policy_name": "deny_policy"
}
api-denytypeでは、次のいずれかの値を指定できます。
-
RESPONDWITH
-
RESET
各属性の詳細については、Deny ruleを参照してください。