8.2 APIリリースノート

Qualys API リリースノート
バージョン 8.2
2014 年 10 月 1 日
Qualys 8.2 の Qualys API では、ユー ザ の プ ロ グ ラ ム お よ び API 呼 び 出 し を Qualys Vulnerability
Management(VM)および Qualys Policy Compliance(PC)に統合するために改善が行われました。API
ユーザガイドを参照するには、Qualys アカウントにログインして、「Help」→「Resources」を選択してく
ださい。
新機能
スキャンリスト v2 出力 - 処理ステータスの追加
スキャンリスト v2 出力 - スキャン時間の追加
スケジュールスキャン v1 出力 - ネットワーク ID の追加
Scanner Appliance API v2 - 仮想アプライアンスの VLAN と静的ルートの管理
Scanner Appliance リスト API v2 - 使用可能な容量の割合(%)の表示
除外 IP API – 除外 IP リストの管理
ダウンロードレポートでのアセットグループ ID の表示
検出 API v2 - 出力への重大度の追加
Policy Compliance - ポリシー API v2 - アセットグループの管理
Policy Compliance - コントロールの重要度
Policy Compliance - EC2 スキャンのサポート
Asset Management - Policy Compliance のアセットのアクティブ化
基本 URL について - ドキュメントとサンプルコードでは、Qualys US プラットフォーム 1 の API サーバの
URL を使用しています。別の基本 URL がある場合は、そちらを使用してください。
アカウントログイン
基本 URL
Qualys US プラットフォーム 1
https://qualysapi.qualys.com
Qualys US プラットフォーム 2
https://qualysapi.qg2.apps.qualys.com
Qualys EU プラットフォーム
https://qualysapi.qualys.eu
Qualys プライベートクラウドプラットフォーム
https://qualysapi.<customer_base_url>
Copyright 2014 by Qualys, Inc. All Rights Reserved.
スキャンリスト v2 出力 - 処理ステータスの追加
スキャンリスト v2 出力 - 処理ステータスの追加
スキャンリスト v2 出力の新しい PROCESSED 要素で、各スキャンのスキャン結果が処理された
かどうかがわかるようになりました。スキャン結果が処理されると、スキャンの検出結果について
のレポートを実行できます。脆弱性スキャン(/api/2.0/fo/scan/?action=list を使用)とコンプライ
アンススキャン(/api/2.0/fo/scan/?action=list を使用)の処理ステータスが表示されます。
新たにスキャンリストフィルタ「processed」
(処理済み)も追加されました。このパラメータを使
用すると、スキャンが処理されたかどうかに基づいて、スキャンリストの出力をフィルタリングで
きます。
パラメータ
processed={0|1}
説明
(オプション)0 を指定すると、処理されていないスキャン
のみが表示されます。1 を指定すると、処理されたスキャ
ンのみが表示されます。パラメータを指定しない場合、ス
キャンリスト出力は、処理ステータスに基づいてフィルタ
リングされません。
API リクエスト :
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/scan/?action=list&processed=1"
XML 出力 :
<SCAN_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2014-09-19T14:21:44Z</DATETIME>
<SCAN_LIST>
<SCAN>
<REF>scan/1411113915.85598</REF>
<TYPE>Scheduled</TYPE>
<TITLE><![CDATA[My Scheduled Scan]]></TITLE>
<USER_LOGIN>acme_xl1</USER_LOGIN>
<LAUNCH_DATETIME>2014-09-19T08:05:15Z</LAUNCH_DATETIME>
<DURATION>00:04:53</DURATION>
<PROCESSED>1</PROCESSED>
<STATUS>
<STATE>Finished</STATE>
</STATUS>
<TARGET><![CDATA[10.10.10.10]]></TARGET>
</SCAN>
...
</SCAN_LIST>
</RESPONSE>
</SCAN_LIST_OUTPUT>
Qualys API リリースノート
2
スキャンリスト v2 出力 - 処理ステータスの追加
DTD の更新 :
スキャンリスト出力 DTD(/api/2.0/fo/scan/scan_list_output.dtd)に PROCESSED 要素が追加さ
れました。
...
<!ELEMENT SCAN_LIST (SCAN+)>
<!ELEMENT SCAN (ID?, REF, TYPE, TITLE, USER_LOGIN, LAUNCH_DATETIME,
DURATION, PROCESSED, STATUS?, TARGET,
ASSET_GROUP_TITLE_LIST?, OPTION_PROFILE?)>
<!ELEMENT ID (#PCDATA)>
<!ELEMENT REF (#PCDATA)>
<!ELEMENT TYPE (#PCDATA)>
<!ELEMENT TITLE (#PCDATA)>
<!ELEMENT LAUNCH_DATETIME (#PCDATA)>
<!ELEMENT DURATION (#PCDATA)>
<!ELEMENT PROCESSED (#PCDATA)>
<!ELEMENT STATUS (STATE, SUB_STATE?)>
<!ELEMENT STATE (#PCDATA)>
<!ELEMENT SUB_STATE (#PCDATA)>
...
Qualys API リリースノート
3
スキャンリスト v2 出力 - スキャン時間の追加
スキャンリスト v2 出力 - スキャン時間の追加
スキャンリスト v2 出力の新しい DURATION 要素で、各スキャンの時間(スキャンの完了までにか
かった時間)がわかるようになりました。これは、スキャン時間の監査に役立ちます。脆弱性スキャ
ン(/api/2.0/fo/scan/?action=list を使用)とコンプライアンススキャン(/api/2.0/fo/scan/?action=list を
使用)のスキャン時間が表示されます。終了していないスキャン(例えば、実行待ち、実行中など)
の時間は、
「Pending」となります。
API リクエスト :
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/scan/?action=list"
XML 出力 :
SCAN_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2014-06-17T16:54:54Z</DATETIME>
<SCAN_LIST>
<SCAN>
<REF>scan/1400915965.42068</REF>
<TYPE>Scheduled</TYPE>
<TITLE>
<![CDATA[My First Scan]]>
</TITLE>
<USER_LOGIN>acme_xl1</USER_LOGIN>
<LAUNCH_DATETIME>2014-05-24T07:19:25Z</LAUNCH_DATETIME>
<DURATION>00:05:08</DURATION>
<PROCESSED>1</PROCESSED>
<STATUS>
<STATE>Finished</STATE>
</STATUS>
<TARGET>
<![CDATA[10.10.10.10]]>
</TARGET>
</SCAN>
...
</SCAN_LIST>
</RESPONSE>
</SCAN_LIST_OUTPUT>
Qualys API リリースノート
4
スキャンリスト v2 出力 - スキャン時間の追加
DTD の更新 :
スキャンリスト出力 DTD(/api/2.0/fo/scan/scan_list_output.dtd)に DURATION 要素が追加され
ました。
...
<!ELEMENT SCAN_LIST (SCAN+)>
<!ELEMENT SCAN (ID?, REF, TYPE, TITLE, USER_LOGIN, LAUNCH_DATETIME,
DURATION, PROCESSED, STATUS?, TARGET,
ASSET_GROUP_TITLE_LIST?, OPTION_PROFILE?)>
<!ELEMENT ID (#PCDATA)>
<!ELEMENT REF (#PCDATA)>
<!ELEMENT TYPE (#PCDATA)>
<!ELEMENT TITLE (#PCDATA)>
<!ELEMENT LAUNCH_DATETIME (#PCDATA)>
<!ELEMENT DURATION (#PCDATA)>
<!ELEMENT PROCESSED (#PCDATA)>
<!ELEMENT STATUS (STATE, SUB_STATE?)>
<!ELEMENT STATE (#PCDATA)>
<!ELEMENT SUB_STATE (#PCDATA)>
...
Qualys API リリースノート
5
スケジュールスキャン v1 出力 - ネットワーク ID の追加
スケジュールスキャン v1 出力 - ネットワーク ID の
追加
スケジュールスキャン v1 API(/msp/scheduled_scans.php)によって返されるスケジュールスキャ
ン v1 出力のネットワーク要素に、属性「network_id」が追加されました。「network_id」要素は、
API ユーザがカスタムネットワークにアクセスしたときのみ表示されます。
API リクエスト :
curl -u "USERNAME:PASSWD"
"https://qualysapi.qualys.com/msp/scheduled_scans.php"
XML 出力 - ユーザ入力の IP:
...
<USER_ENTERED_IPS network_id= "12345">
<RANGE>
<START>192.169.1.12</START>
<END>192.169.1.12</END>
</RANGE>
</USER_ENTERED_IPS>
...
XML 出力 - IP の除外 :
...
<EXCLUDE_IP_PER_SCAN network_id="12345">10.10.1.61, 10.10.2.3-10.10.2.63
</EXCLUDE_IP_PER_SCAN>
...
XML 出力 - マップのドメイン :
...
<TYPE>MAP</TYPE>
<USER_ENTERED_DOMAINS>
<DOMAIN>
<DOMAIN_NAME network_id="15555"><![CDATA[none]]></DOMAIN_NAME>
<NETBLOCK>
<RANGE>
<START>10.10.24.2</START>
<END>10.10.24.255</END>
</RANGE>
</NETBLOCK>
</DOMAIN>
</USER_ENTERED_DOMAINS>
...
Qualys API リリースノート
6
スケジュールスキャン v1 出力 - ネットワーク ID の追加
DTD の更新 :
スケジュールスキャン DTD(scheduled_scans.dtd)で「network_id」属性が追加された要素は、
EXCLUDE_IP_PER_SCAN、DOMAIN_NAME、USER_ENTERED_IPS です。
<!-- QUALYS SCHEDULED TASKS DTD -->
<!ELEMENT SCHEDULEDSCANS (SCAN*|ERROR)>
<!ELEMENT SCAN
(TITLE,TARGETS,SCHEDULE,NEXTLAUNCH_UTC?,DEFAULT_SCANNER?,ISCANNER_NAME?,O
PTION?,TYPE, ASSET_GROUPS?, EXCLUDE_IP_PER_SCAN?, USER_ENTERED_DOMAINS?,
USER_ENTERED_IPS?, NETWORK_ID?,OPTION_PROFILE?)>
<!ATTLIST SCAN
active (yes|no) #REQUIRED
ref CDATA #REQUIRED>
...
<!ELEMENT ASSET_GROUP (ASSET_GROUP_TITLE, NETWORK_ID?)>
<!ELEMENT ASSET_GROUPS (ASSET_GROUP+)>
<!ELEMENT ASSET_GROUP_TITLE (#PCDATA)>
<!ELEMENT NETWORK_ID (#PCDATA)>
<!ELEMENT EXCLUDE_IP_PER_SCAN (#PCDATA)>
<!ATTLIST EXCLUDE_IP_PER_SCAN
network_id CDATA #IMPLIED
>
<!ELEMENT USER_ENTERED_DOMAINS (DOMAIN*)>
<!ELEMENT DOMAIN (DOMAIN_NAME+, NETBLOCK*)>
<!ELEMENT DOMAIN_NAME (#PCDATA)>
<!ATTLIST DOMAIN_NAME
network_id CDATA #IMPLIED
>
<!ELEMENT NETBLOCK (RANGE+)>
<!ELEMENT RANGE (START+, END+)>
<!ELEMENT START (#PCDATA)>
<!ELEMENT END (#PCDATA)>
<!ELEMENT USER_ENTERED_IPS (RANGE*)>
<!ATTLIST USER_ENTERED_IPS
network_id CDATA #IMPLIED
>
...
Qualys API リリースノート
7
Scanner Appliance API v2 - 仮想アプライアンスの VLAN と静的ルートの管理
Scanner Appliance API v2 - 仮想アプライアンスの
VLAN と静的ルートの管理
Scanner Appliance API(/api/2.0/fo/appliance/?action=update)を使用して、Scanner Appliance(仮
想アプライアンス)の VLAN と静的ルートを管理します。新しいパラメータの「set_vlans」と
「set_routes」を使用して、これらの設定を追加、更新、削除します。
必要事項 - Qualys アカウントで、VLAN と静的ルート機能を有効にする必要があります。この機
能を有効にする場合は、サポートチームまたは Qualys TAM にお問い合わせください。
Scanner Appliance での VLAN の設定
「set_vlans」パラメータを使用して、1 つ以上の VLAN を指定します。
「ID|IP_ADDRESS|NETMASK|NAME」という形式で設定します。区切
単一の VLAN の場合は、
り文字としてパイプ(|)を使用します。すべての属性が必須です(ID、IP_ADDRESS など)
。複
数の VLAN を設定する場合は、カンマで区切って指定します。
キーポイント API 呼び出しで、パラメータ「set_vlans」を空に設定すると、Scanner Appliance 。
に割り当てられたすべての VLAN が置き換えられます(すなわち、削除されます)
属性
説明
ID
ユーザ定義の ID(Qualys による指定ではありません)。0
~ 4094 で指定しなければなりません(4094 も含む)。
IP_ADDRESS
有効な IPv4 IP アドレス(ドット区切りの 10.10.10.1 など)。
NETMASK
有効なネットワークマスク(ドット区切りの 255.255.255.0
など)
。
NAME
有効な名前(空でもかまいません)。名前は最大 256 の
ASCII 文字です。:(コロン)は使用できます。次の特殊文
字は使用できません :,(カンマ)、<(未満)
、>(より大き
い)、"(二重引用符)、&(アンパサンド)、|(パイプ)、=
(等号)
。
API リクエスト(単一の VLAN):
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -X "POST" -d
"id=43463&set_vlans=0|10.10.10.1|255.255.255.0|vlan1"
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=update"
API リクエスト(複数の VLAN):
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -X "POST" -d
"id=43463&set_vlans=1|10.10.10.1|255.255.255.0|vlan1,2|10.10.10.2|255.255
.255.0|vlan2"
Qualys API リリースノート
8
Scanner Appliance API v2 - 仮想アプライアンスの VLAN と静的ルートの管理
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=update"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-07-09T08:46:54Z</DATETIME>
<TEXT>Virtual scanner updated successfully</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>43463</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
Scanner Appliance での静的ルートの設定
「set_routes」パラメータを使用して、1 つ以上の静的ルートを指定します。単一の静的ルートの場
合は、
「IP_ADDRESS|NETMASK|GATEWAY|NAME」という形式で設定します。区切り文字と
してパイプ(|)を使用します。すべての属性が必須です(IP_ADDRESS、NETMASK など)。複
数の静的ルートを設定する場合は、カンマで区切って指定します。
キーポイント API 呼び出しで、パラメータ「set_routes」を空に設定すると、Scanner Appliance に割り当てられたすべての静的ルートが置き換えられます(すなわち、削除されます)。
属性
説明
IP_ADDRESS
有効な IPv4 IP アドレス(ドット区切りの 10.10.26.0 など)。
NETMASK
有効なネットワークマスク(ドット区切りの 255.255.255.0 な
ど)。
GATEWAY
有効な IPv4 IP アドレス(ドット区切りの 10.10.25.255 など)
。
NAME
有効な名前(空でもかまいません)
。名前は最大 256 の ASCII
文字です。:(コロン)は使用できます。次の特殊文字は使用で
、<(未満)
、>(より大きい)、"(二重引
きません :,(カンマ)
用符)、&(アンパサンド)、|(パイプ)
、=(等号)
。
API リクエスト(単一の静的ルート):
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -X "POST" -d
"id=43463&set_routes=10.10.25.0|255.255.255.0|10.10.25.255|SRoute1"
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=update"
Qualys API リリースノート
9
Scanner Appliance API v2 - 仮想アプライアンスの VLAN と静的ルートの管理
API リクエスト(複数の静的ルート):
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -X "POST" -d
"id=43463&set_routes=10.10.25.0|255.255.255.0|10.10.25.255|Route1,10.10.2
6.0|255.255.255.0|10.10.26.255|Route2"
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=update"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-07-09T08:49:18Z</DATETIME>
<TEXT>Virtual scanner updated successfully</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>43463</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
VLAN と静的ルートを設定した Scanner Appliance の表示
パラメータ「action=list」および「output_mode=full」を使用します。
API リクエスト :
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=list&ids=43463
&output_mode=full"
XML 出力 :
...
<VLANS>
<SETTING>Enabled</SETTING>
<VLAN>
<ID>0</ID>
<NAME>vlan1</NAME>
<IP_ADDRESS>10.10.10.1</IP_ADDRESS>
<NETMASK>255.255.255.0</NETMASK>
</VLAN>
</VLANS>
<STATIC_ROUTES>
<ROUTE>
Qualys API リリースノート
10
Scanner Appliance API v2 - 仮想アプライアンスの VLAN と静的ルートの管理
<NAME>Route1</NAME>
<IP_ADDRESS>10.10.25.0</IP_ADDRESS>
<NETMASK>255.255.255.0</NETMASK>
<GATEWAY>10.10.25.255</GATEWAY>
</ROUTE>
<ROUTE>
<NAME>Route2</NAME>
<IP_ADDRESS>10.10.26.0</IP_ADDRESS>
<NETMASK>255.255.255.0</NETMASK>
<GATEWAY>10.10.26.255</GATEWAY>
</ROUTE>
</STATIC_ROUTES>
...
すべての VLAN レコードの削除
「set_vlans」パラメータを空に設定します。
API リクエスト(すべての VLAN レコードの削除):
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -d
"id=43463&set_vlans="
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=update"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-07-09T08:49:18Z</DATETIME>
<TEXT>Virtual scanner updated successfully</TEXT>
...
すべての静的ルートレコードの削除
「set_routes」パラメータを空に設定します。
API リクエスト(すべての静的ルートレコードの削除):
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -d
"id=43463&set_routes="
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=update"
Qualys API リリースノート
11
Scanner Appliance API v2 - 仮想アプライアンスの VLAN と静的ルートの管理
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-07-09T08:49:18Z</DATETIME>
<TEXT>Virtual scanner updated successfully</TEXT>
...
Qualys API リリースノート
12
Scanner Appliance リスト API v2 - 使用可能な容量の割合(%)の表示
Scanner Appliance リスト API v2 - 使用可能な容量の
割合(%)の表示
Scanner Appliance リ ス ト API v2(/api/2.0/fo/appliance)は、ユ ー ザ ア カ ウ ン ト の Scanner
Appliance のリストを提供します。属性「output_mode=full」が設定されると、XML 出力の新し
い要素の MAX_CAPACITY_UNITS に、使用可能な容量の割合が表示されます。
API リクエスト :
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/appliance/?action=list&ids=43463
&output_mode=full"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE APPLIANCE_LIST_OUTPUT SYSTEM
"https://qualysapi.qualys.com/api/2.0/fo/appliance/appliance_list_output.
dtd">
<APPLIANCE_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2014-08-06T08:30:19Z</DATETIME>
<APPLIANCE_LIST>
<APPLIANCE>
<ID>43463</ID>
...
<UPDATED>Yes</UPDATED>
<COMMENTS><![CDATA[]]></COMMENTS>
<MAX_CAPACITY_UNITS>100</MAX_CAPACITY_UNITS>
</APPLIANCE>
</APPLIANCE_LIST>
</RESPONSE>
</APPLIANCE_LIST_OUTPUT>
Qualys API リリースノート
13
Scanner Appliance リスト API v2 - 使用可能な容量の割合(%)の表示
DTD の更新 :
アプライアンスリスト出力 DTD(/api/2.0/fo/appliance/appliance_list_output.dtd)に
MAX_CAPACITY_UNITS 要素が追加されました。
...
<!ELEMENT RESPONSE (DATETIME, APPLIANCE_LIST?, LICENSE_INFO?)>
<!ELEMENT APPLIANCE_LIST (APPLIANCE+)>
<!ELEMENT APPLIANCE (ID, NAME, NETWORK_ID?, SOFTWARE_VERSION,
RUNNING_SCAN_COUNT, STATUS, MODEL_NUMBER?,
SERIAL_NUMBER?, ACTIVATION_CODE?,
INTERFACE_SETTINGS*, PROXY_SETTINGS?, VLANS?,
STATIC_ROUTES?, ML_LATEST?, ML_VERSION?,
VULNSIGS_LATEST?, VULNSIGS_VERSION?,
ASSET_GROUP_COUNT?, ASSET_GROUP_LIST?,
LAST_UPDATED_DATE?, POLLING_INTERVAL?, USER_LOGIN?,
HEARTBEATS_MISSED?, SS_CONNECTION?,
SS_LAST_CONNECTED?, FDCC_ENABLED?, USER_LIST?,
UPDATED?, COMMENTS?, RUNNING_SCANS?,
MAX_CAPACITY_UNITS?)>
...
<!ELEMENT UPDATED (#PCDATA)>
<!ELEMENT COMMENTS (#PCDATA)>
<!ELEMENT RUNNING_SCANS (SCAN+)>
<!ELEMENT MAX_CAPACITY_UNITS (#PCDATA)>
...
Qualys API リリースノート
14
除外 IP API – 除外 IP リストの管理
除外 IP API – 除外 IP リストの管理
バージョン 8.2 では、除外 IP API v2(/api/2.0/fo/asset/excluded_ip/)を使用して、除外 IP リスト
を管理できるようになりました。除外 IP リスト内の IP はスキャンされません。
IP の追加
パラメータ「action=add」を使用して、除外 IP リストに IP を追加します。
パラメータ
説明
action=add
(必須)
ips={value}
(必須)除外 IP リストに追加する IP アドレス。単体の
IPv4 または IPv4 範囲をカンマで区切って入力します。
例 : 10.10.10.13,10.10.10.25-10.10.10.29
comment={value}
(必須)ユーザ定義のコメント(最大 1024 文字)。
network_id={value}
(オプション、リクエストを行うユーザが複数のネット
ワークにアクセスする場合にのみ有効)
除外 IP リストに追加する IP にネットワーク ID を割り当
てます。デフォルトでは、ユーザのデフォルトのネット
ワーク ID が割り当てられます。
API リクエスト 1 - IP の追加 :
curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -d
"action=add&ips=10.10.34.210-10.10.34.212&comment=adding IPs to excluded
list"
"https://qualysapi.qualys.com/api/2.0/fo/asset/excluded_ip/"
XML 出力 :
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-09-14T13:04:31Z</DATETIME>
<TEXT>Adding IPs to Excluded IPs list.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>Added IPs</KEY>
<VALUE>10.10.34.210-10.10.34.212</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
Qualys API リリースノート
15
除外 IP API – 除外 IP リストの管理
API リクエスト 2 - IP がすでに除外 IP リストに存在する場合 :
curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -d
"action=add&ips=10.10.34.210-10.10.34.212&comment=adding, added IPs "
"https://qualysapi.qualys.com/api/2.0/fo/asset/excluded_ip/"
XML 出力 :
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-09-14T13:09:03Z</DATETIME>
<TEXT>Not Adding any IPs to Excluded IPs list.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>IPs already in Excluded IPs list.</KEY>
<VALUE>10.10.34.210-10.10.34.212</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
IP の削除
パラメータ「action=remove」を使用して、除外 IP リストから IP を削除します。
パラメータ
説明
action=remove
(必須)
ips={value}
(必須)除外 IP リストから削除する IP アドレス。単体の
IPv4 または IPv4 範囲をカンマで区切って入力します。
例 : 10.10.10.13,10.10.10.25-10.10.10.29
comment={value}
(必須)ユーザ定義のコメント(最大 1024 文字)
。
network_id={value}
(オプション、リクエストを行うユーザが複数のネット
ワークにアクセスする場合にのみ有効)
除外 IP リストから削除する IP に割り当てられているネッ
トワーク ID を指定します。デフォルトでは、ユーザのデ
フォルトのネットワーク ID が割り当てられます。
Qualys API リリースノート
16
除外 IP API – 除外 IP リストの管理
API リクエスト :
curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -d
"action=remove&ips=10.10.34.250-10.10.34.254&comment=remove IPS"
"https://qualysapi.qualys.com/api/2.0/fo/asset/excluded_ip/"
XML 出力 :
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-09-15T04:05:04Z</DATETIME>
<TEXT>Removed IPs from Excluded IPs list.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>Removed IPs</KEY>
<VALUE>10.10.34.250-10.10.34.254</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
Qualys API リリースノート
17
ダウンロードレポートでのアセットグループ ID の表示
ダウンロードレポートでのアセットグループ ID の表示
QualysGuard のユーザインタフェースで、アセットグループの ID が簡単に確認できるようになり
ました。これを表示するには、アセットグループリスト(
「Assets」→「Asset Groups」)を選択し
ます。必ず、
「Tools」メニューから ID カラムを選択してください。リストに表示されているアセッ
トグループと一緒に ID をダウンロードするには、「New」→「Download」を選択して、形式
(CSV、HTML、MHT、XML)を選択します。
CSV 形式の例 :
XML 形式の例 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE DATALIST SYSTEM "https://qualysguard.qualys.com/datalist.dtd">
<DATALIST>
<HEADER>
<NAME>Asset Groups</NAME>
<GENERATION_DATETIME>08/27/2014 at 11:44:25 (GMT-0700)
</GENERATION_DATETIME>
...
</HEADER>
<LIST>
<NB_RECORDS>37</NB_RECORDS>
<RECORD>
<KEY name="TITLE"><![CDATA[Windows 2003 Server Asset Group]]></KEY>
<KEY name="ID"><![CDATA[416004]]></KEY>
<KEY name="IPS"><![CDATA[10.10.25.12]]></KEY>
<KEY name="DOMAINS"><![CDATA[]]></KEY>
<KEY name="APPLIANCES"><![CDATA[0]]></KEY>
<KEY name="BUSINESS_IMPACT"><![CDATA[High]]></KEY>
<KEY name="USER"><![CDATA[Victor Smith (Manager)]]></KEY>
<KEY name="MODIFIED"><![CDATA[02/12/2014 at 14:57:17 (GMT0700)]]></KEY>
</RECORD>
<RECORD>
<KEY name="TITLE"><![CDATA[AG WS2K8]]></KEY>
<KEY name="ID"><![CDATA[611412]]></KEY>
<KEY name="IPS"><![CDATA[10.10.24.203-10.10.24.204, 10.10.24.21410.10.24.215, 10.10.24.218-10.10.24.219]]></KEY>
Qualys API リリースノート
18
ダウンロードレポートでのアセットグループ ID の表示
<KEY name="DOMAINS"><![CDATA[]]></KEY>
<KEY name="APPLIANCES"><![CDATA[0]]></KEY>
<KEY name="BUSINESS_IMPACT"><![CDATA[High]]></KEY>
<KEY name="USER"><![CDATA[Phil Niegos (Manager)]]></KEY>
<KEY name="MODIFIED"><![CDATA[02/12/2014 at 14:16:21 (GMT0700)]]></KEY>
</RECORD>
<RECORD>
<KEY name="TITLE"><![CDATA[AG Vista]]></KEY>
<KEY name="ID"><![CDATA[611409]]></KEY>
<KEY name="IPS"><![CDATA[10.10.24.200, 10.10.24.20810.10.24.211]]></KEY>
<KEY name="DOMAINS"><![CDATA[]]></KEY>
<KEY name="APPLIANCES"><![CDATA[0]]></KEY>
<KEY name="BUSINESS_IMPACT"><![CDATA[High]]></KEY>
<KEY name="USER"><![CDATA[Phil Niegos (Manager)]]></KEY>
<KEY name="MODIFIED"><![CDATA[02/12/2014 at 14:12:01 (GMT0700)]]></KEY>
</RECORD>
...
Qualys API リリースノート
19
検出 API v2 - 出力への重大度の追加
検出 API v2 - 出力への重大度の追加
ホスト検出 API v2(/api/2.0/fo/asset/host/vm/detection/?action=list)で返される XML 出力に、脆
弱性の重大度が追加されました。検出リスト出力 DTD が更新されました。
API リクエスト :
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/asset/host/vm/detection/?action=
list"
XML 出力 :
...
<DETECTION>
<QID>90783</QID>
<TYPE>Confirmed</TYPE>
<SEVERITY>5</SEVERITY>
...
<DETECTION>
<QID>90781</QID>
<TYPE>Potential</TYPE>
<SEVERITY>3</SEVERITY>
...
DTD の更新 :
検出リスト出力 DTD(/api/2.0/fo/asset/host/vm/detection/host_list_vm_detection_output.dtd)に
SEVERITY 要素が追加されました。
...
<!ELEMENT DETECTION (QID, TYPE, SEVERITY?, PORT?, PROTOCOL?, FQDN?, SSL?,
INSTANCE?, RESULTS?, STATUS?, FIRST_FOUND_DATETIME?,
LAST_FOUND_DATETIME?,
LAST_TEST_DATETIME?, LAST_UPDATE_DATETIME?,
LAST_FIXED_DATETIME?)>
<!ELEMENT QID (#PCDATA)>
<!ELEMENT TYPE (#PCDATA)>
<!ELEMENT SEVERITY (#PCDATA)>
...
Qualys API リリースノート
20
Policy Compliance - ポリシー API v2 - アセットグループの管理
Policy Compliance - ポリシー API v2 - アセットグループ
の管理
Qualys 8.2 では、新しいアクションを使用するコンプライアンスポリシー API(/api2.0/fo/compliance/
policy)を使用して、ポリシーのアセットグループを管理できるようになりました。更新対象のポリ
シーを変更するためのパーミッションが必要です。
action=add_asset_group_ids
このアクションを使用して、指定したポリシーにアセットグループを追加します。パラメータは以
下の通りです。
パラメータ
説明
id={value}
更新するポリシーのポリシー ID。
asset_group_ids={value}
「id」に指定したポリシーに追加するアセットグループのア
セットグループ ID。複数の ID がある場合は、カンマで区
切ります。各アセットグループには、少なくとも 1 つの IP
アドレスが割り当てられている必要があります。
API リクエスト :
curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -X POST -d
"id=43400&asset_group_ids=649737,649736"
"https://qualysapi.qualys.com//api/2.0/fo/compliance/policy/?action=add_a
sset_group_ids"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-09-11T09:06:17Z</DATETIME>
<TEXT>Compliance Policy successfully modified.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>43400</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
Qualys API リリースノート
21
Policy Compliance - ポリシー API v2 - アセットグループの管理
action=remove_asset_group_ids
このアクションを使用して、指定したポリシーからアセットグループを削除します。パラメータは
以下の通りです。
パラメータ
説明
id={value}
更新するポリシーのポリシー ID。
asset_group_ids=
{value}
「id」に指定したポリシーから削除するアセットグループの
アセットグループ ID。複数の ID がある場合は、カンマで
区切ります。
API リクエスト :
curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -X POST -d
"id=43400&asset_group_ids=649737,649736"
"https://qualysapi.qualys.com//api/2.0/fo/compliance/policy/?action=remov
e_asset_group_ids"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-09-11T09:06:17Z</DATETIME>
<TEXT>Compliance Policy successfully modified.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>43400</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
Qualys API リリースノート
22
Policy Compliance - ポリシー API v2 - アセットグループの管理
action=set_asset_group_ids
このアクションを使用して、指定したポリシーのアセットグループを再設定します。このリクエスト
で指定されない割り当て済みのアセットグループは、削除されます。パラメータは以下の通りです。
パラメータ
説明
id={value}
更新するポリシーのポリシー ID。
asset_group_ids={value}
「id」に指定したポリシーに割り当てるアセットグループの
アセットグループ ID。複数の ID がある場合は、カンマで
区切ります。各アセットグループには、少なくとも 1 つの
IP アドレスが割り当てられている必要があります。
API リクエスト :
curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -X POST -d
"id=43400&asset_group_ids=649737,649736"
"https://qualysapi.qualys.com//api/2.0/fo/compliance/policy/?
action=set_asset_group_ids"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-09-11T09:07:43Z</DATETIME>
<TEXT>Compliance Policy successfully modified.</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>43400</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
Qualys API リリースノート
23
Policy Compliance - コントロールの重要度
Policy Compliance - コントロールの重要度
今回のリリースでは、Policy Compliance モジュールに、コントロールの重要度評価の新機能が導
入されました。XML および CSV 出力にいくつか変更が加えられました。これは既存の API の実
装に影響を与える可能性があります。さらに、状態情報 API に新しいオプションのパラメータが 2
つ追加されました。これは既存の実装に影響を与えません。その他の新しい API 機能に関する情
報、詳しい説明や例などは、リリース前に公開される予定です。
完全版のリリースノートは、リリース時に入手可能になります。
コントロールの重要度とは
コントロールの重要度は、Policy Compliance の新機能です。これにより、コントロールを評価す
ることができます。また、コントロールレベルとポリシーレベルでの評価をカスタマイズすること
も可能です。複数の API が更新され、API 出力にこのデータが追加されるようになりました。
アカウントでの事前設定(コントロールの重要度を有効にする)
コントロールライブラリでデフォルトの重要度の設定が更新されている間は、コントロールの重要
度はデフォルトでは利用できません。この機能の詳細については、サポートまたはテクニカルアカ
ウントマネージャにお問い合わせください。
コンプライアンス状態情報 - 新しい入力パラメータ
コンプライアンス状態情報 API v2(/api/2.0/fo/compliance/posture/info/?action=list)で、新しい
「criticality」入力パラメータを使用して、コントロールの重要度によって状態情報レコード出力を
フィルタリングします。
パラメータ
説明
criticality_labels={value}
(オプション)特定の重要度ラベルを持つコントロールの
コンプライアンス状態情報レコードのみを表示します。
1 つ以上の重要度ラベル(SERIOUS、CRITICAL、
URGENT など)を指定します。複数のエントリがある場
合は、カンマで区切ります。
criticality_values={value}
(オプション)特定の重要度値を持つコントロールのコン
プライアンス状態情報レコードのみを表示します。1 つ以
上の重要度値(0 ~ 5)を指定します。複数のエントリが
ある場合は、カンマで区切ります。
注意 - criticality_labels パラメータと criticality_values パラメータは相互に排他的であり、同じ
リクエスト内で指定することはできません。
Qualys API リリースノート
24
Policy Compliance - コントロールの重要度
API リクエスト :
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/compliance/posture/info/?action=
list&policy_id=44579&ips=10.10.10.28&criticality_values=5"
XML 出力 :
...
<CONTROL_LIST>
<CONTROL>
<ID>1045</ID>
<STATEMENT><![CDATA[Status of the 'Clipbook' service (startup
type)]]></STATEMENT>
<CRITICALITY>
<LABEL><![CDATA[URGENT]]></LABEL>
<VALUE>5</VALUE>
</CRITICALITY>
</CONTROL>
</CONTROL_LIST>
...
DTD の更新 :
状 態 情 報 リ ス ト 出 力 DTD(/api/2.0/fo/compliance/posture/info/posture_info_list_output.dtd)に
CRITICALITY 要素が追加されました。
...
<!ELEMENT CONTROL_LIST (CONTROL+)>
<!ELEMENT CONTROL (ID, STATEMENT, CRITICALITY?, DEPRECATED?,
RATIONALE_LIST?)>
<!ELEMENT STATEMENT (#PCDATA)>
<!ELEMENT CRITICALITY (LABEL, VALUE)>
<!ELEMENT DEPRECATED (#PCDATA)>
<!ELEMENT RATIONALE_LIST (RATIONALE*)>
<!ELEMENT RATIONALE (TECHNOLOGY_ID, TEXT)>
...
コンプライアンスコントロールリスト
コンプライアンスコントロールリスト API v2(api/2.0/fo/compliance/control/?action=list)で返さ
れる XML 出力に、コントロールの重要度が追加されました。
API リクエスト :
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/compliance/control/?action=list&
ids=1071"
Qualys API リリースノート
25
Policy Compliance - コントロールの重要度
XML 出力 :
...
<CONTROL_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2014-08-27T10:00:01Z</DATETIME>
<CONTROL_LIST>
<CONTROL>
<ID>1071</ID>
<UPDATE_DATE>2014-05-08T00:00:00Z</UPDATE_DATE>
<CREATED_DATE>2007-10-17T00:00:00Z</CREATED_DATE>
<CATEGORY>Access Control Requirements</CATEGORY>
<SUB_CATEGORY><![CDATA[Authentication/Passwords]]></SUB_CATEGORY>
<STATEMENT><![CDATA[Status of the 'Minimum Password Length'
setting]]></STATEMENT>
<CRITICALITY>
<LABEL><![CDATA[MEDIUM]]></LABEL>
<VALUE>2</VALUE>
</CRITICALITY>
...
DTD の更新 :
コ ン ト ロー ル リス ト 出力
DTD(/api/2.0/fo/compliance/control/control_list_output.dtd)に
CRITICALITY 要素が追加されました。
...
<!ELEMENT CONTROL (ID, UPDATE_DATE, CREATED_DATE, CATEGORY, SUB_CATEGORY,
STATEMENT, CRITICALITY?, DEPRECATED?,
DEPRECATED_DATE?, TECHNOLOGY_LIST, FRAMEWORK_LIST?)>
<!ELEMENT ID (#PCDATA)>
<!ELEMENT UPDATE_DATE (#PCDATA)>
<!ELEMENT CREATED_DATE (#PCDATA)>
<!ELEMENT CATEGORY (#PCDATA)>
<!ELEMENT SUB_CATEGORY (#PCDATA)>
<!ELEMENT STATEMENT (#PCDATA)>
<!ELEMENT CRITICALITY (LABEL, VALUE)>
<!ELEMENT LABEL (#PCDATA)>
...
コンプライアンスポリシーリスト
コンプライアンスポリシーリスト API v2(/api/2.0/fo/compliance/policy/?action=list)で返される
XML 出力に、コントロールの重要度が追加されました。
API リクエスト :
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/compliance/policy/?action=list&i
ds=44579"
Qualys API リリースノート
26
Policy Compliance - コントロールの重要度
XML 出力 :
...
<POLICY_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2014-08-27T09:55:38Z</DATETIME>
<POLICY_LIST>
<POLICY>
<ID>44579</ID>
<TITLE><![CDATA[My Policy]]></TITLE>
<CREATED>
<DATETIME>2014-08-27T08:46:28Z</DATETIME>
<BY>qualys_user</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2014-08-27T09:25:26Z</DATETIME>
<BY>qualys_user</BY>
</LAST_MODIFIED>
<ASSET_GROUP_IDS>641408,648260</ASSET_GROUP_IDS>
<CONTROL_LIST>
<CONTROL>
<ID>1045</ID>
<STATEMENT><![CDATA[Status of the 'Clipbook' service (startup
type)]]></STATEMENT>
<CRITICALITY>
<LABEL><![CDATA[URGENT]]></LABEL>
<VALUE>5</VALUE>
</CRITICALITY>
</CONTROL>
...
DTD の更新 :
ポリシーリスト出力 DTD
(/api/2.0/fo/compliance/policy/policy_list_output.dtd)に CRITICALITY
要素が追加されました。
...
<!ELEMENT CONTROL_LIST (CONTROL+)>
<!ELEMENT CONTROL (ID, STATEMENT, CRITICALITY?, DEPRECATED?,
TECHNOLOGY_LIST?)>
<!ELEMENT STATEMENT (#PCDATA)>
<!ELEMENT CRITICALITY (LABEL, VALUE)>
<!ELEMENT LABEL (#PCDATA)>
<!ELEMENT DEPRECATED (#PCDATA)>
...
Qualys API リリースノート
27
Policy Compliance - コントロールの重要度
コンプライアンスポリシーのインポート
コンプライアンスポリシーのインポート API v2(/api/2.0/fo/compliance/policy/?action=import)を
使用して、XML ファイルで定義されたコンプライアンスポリシーをアカウントにインポートでき
ます。インポートされたポリシーに新しい CRITICALITY 要素が追加されます。この API には
HTTP POST メソッドが必要で、シンプルな応答用 DTD が使用されます。DTD は変更されてい
ません。
API リクエスト :
curl -k -u "USERNAME:PASSWORD" -H "Content-type: text/xml" -X "POST"
--data-binary @policy.xml
"https://qualysapi.qualys.com/api/2.0/fo/compliance/policy/?action=import
&title=My+Policy"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<RESPONSE>
<DATETIME>2014-08-27T10:07:05Z</DATETIME>
<TEXT>Successfully imported compliance policy</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>44580</VALUE>
</ITEM>
<ITEM>
<KEY>TITLE</KEY>
<VALUE>My Policy</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
コンプライアンスポリシーのエクスポート
コンプライアンスポリシーのエクスポート API v2(/api/2.0/fo/compliance/policy/?action=export)
で返される XML 出力に、コントロールの重要度が追加されました。
API リクエスト :
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl"
"https://qualysapi.qualys.com/api/2.0/fo/compliance/policy/?action=export
&id=44579"
Qualys API リリースノート
28
Policy Compliance - コントロールの重要度
XML 出力 :
...
<SECTION>
<NUMBER>1</NUMBER>
<HEADING><![CDATA[Untitled]]></HEADING>
<CONTROLS total="1">
<CONTROL>
<ID>1045</ID>
<CRITICALITY>
<LABEL><![CDATA[URGENT]]></LABEL>
<VALUE>5</VALUE>
</CRITICALITY>
...
DTD の更新 :
ポ リ シー エ クス ポ ート 出 力 DTD(/api/2.0/fo/compliance/policy/policy_export_output.dtd)に
CRITICALITY 要素が追加されました。
...
<!ELEMENT
<!ATTLIST
<!ELEMENT
<!ELEMENT
CONTROLS (CONTROL*)>
CONTROLS total CDATA #IMPLIED>
CONTROL (ID, CRITICALITY?, TECHNOLOGIES)>
ID (#PCDATA)>
<!ELEMENT CRITICALITY (LABEL, VALUE)>
<!ELEMENT LABEL (#PCDATA)>
<!ELEMENT VALUE (#PCDATA)>
...
コンプライアンスポリシーレポート
Report Share API またはユーザインタフェースから XML 形式または CSV 形式でコンプライアン
スポリシーレポートをダウンロードした際に、コントロールの重要度が表示されるようになりま
す。
XML 出力 :
...
<CONTROLS_SUMMARY>
<CONTROL_INFO>
<ORDER>1.1</ORDER>
<CONTROL_ID>1091</CONTROL_ID>
<STATEMENT><![CDATA[Status of the number of days before a [Prompt
user] password expiration warning prompt is displayed at
login]]></STATEMENT>
<CRITICALITY>
<LABEL><![CDATA[SERIOUS]]></LABEL>
Qualys API リリースノート
29
Policy Compliance - コントロールの重要度
<VALUE>3></VALUE>
</CRITICALITY>
<PERCENTAGE>100% (6 of 6)</PERCENTAGE>
</CONTROL_INFO>
...
<CONTROL>
<ORDER><![CDATA[9.10]]></ORDER>
<CID><![CDATA[1163]]></CID>
<STATEMENT><![CDATA[Status of the 'Prevent users from installing
printer drivers' setting]]></STATEMENT>
<CRITICALITY>
<LABEL><![CDATA[SERIOUS]]></LABEL>
<VALUE>3</VALUE>
</CRITICALITY>
<CATEGORY><![CDATA[Access Control Requirements]]></CATEGORY>
<POSTURE><![CDATA[Passed]]></POSTURE>
</CONTROL>
...
DTD の更新 :
コンプライアンスポリシーレポート DTD(compliance_policy_report.dtd)に CRITICALITY 要素
が追加されました。
...
<!ELEMENT CONTROLS_SUMMARY (CONTROL_INFO*)>
<!ELEMENT CONTROL_INFO (ORDER, CONTROL_ID, STATEMENT, CRITICALITY?,
PERCENTAGE, DEPRECATED?)>
<!ELEMENT CONTROL_ID (#PCDATA)>
<!ELEMENT ORDER (#PCDATA)>
<!ELEMENT PERCENTAGE (#PCDATA)>
<!ELEMENT CRITICALITY (LABEL, VALUE)>
<!ELEMENT DEPRECATED (#PCDATA)>
...
<!ELEMENT CONTROL_LIST (CONTROL*)>
<!ELEMENT CONTROL (CID, STATEMENT, CRITICALITY?, CONTROL_REFERENCES?,
DEPRECATED?, RATIONALE?, INSTANCE?, STATUS,
EVALUATION_DATE?, EVIDENCE?, EXCEPTION?)>
<!ELEMENT CID (#PCDATA)>
<!ELEMENT STATEMENT (#PCDATA)>
...
Qualys API リリースノート
30
Policy Compliance - コントロールの重要度
個別ホストコンプライアンスレポート
Report Share API またはユーザインタフェースから XML 形式または CSV 形式で個別ホストレ
ポートをダウンロードした際に、コントロールの重要度が表示されるようになります。
XML 出力 :
...
<FILTERS>
<POLICY><![CDATA[MY_Policy]]></POLICY>
<ASSET_GROUP><![CDATA[Windows 2000 Targets]]></ASSET_GROUP>
<IP_ADDRESS><![CDATA[10.10.26.154]]></IP_ADDRESS>
<DISPLAY><![CDATA[Passed, Failed and Error]]></DISPLAY>
<CRITICALITY_FILTER><![CDATA[SERIOUS,CRITICAL,URGENT]]>
</CRITICALITY_FILTER>
<SORT_BY><![CDATA[Order]]></SORT_BY>
<POLICY_MODIFIED><![CDATA[05/15/2014 at 09:37:01 (GMT0700)]]></POLICY_MODIFIED>
</FILTERS>
...
<CONTROL>
<ORDER><![CDATA[9.10]]></ORDER>
<CID><![CDATA[1163]]></CID>
<STATEMENT><![CDATA[Status of the 'Prevent users from installing
printer drivers' setting]]></STATEMENT>
<CRITICALITY>
<LABEL><![CDATA[SERIOUS]]></LABEL>
<VALUE>3</VALUE>
</CRITICALITY>
<CATEGORY><![CDATA[Access Control Requirements]]></CATEGORY>
<POSTURE><![CDATA[Passed]]></POSTURE>
</CONTROL>
...
DTD の更新 :
個別ホストコンプライアンスレポート DTD(individual_host_compliance_report.dtd)に
CRITICALITY 要素が追加されました。
...
<!ELEMENT FILTERS (POLICY, ASSET_GROUP, IP_ADDRESS, DISPLAY,
CRITICALITY_FILTER, SORT_BY, POLICY_MODIFIED)>
<!ELEMENT POLICY (#PCDATA)>
<!ELEMENT ASSET_GROUP (#PCDATA)>
<!ELEMENT IP_ADDRESS (#PCDATA)>
<!ELEMENT DISPLAY (#PCDATA)>
<!ELEMENT CRITICALITY_FILTER (#PCDATA)>
<!ELEMENT SORT_BY (#PCDATA)>
<!ELEMENT POLICY_MODIFIED (#PCDATA)>
...
Qualys API リリースノート
31
Policy Compliance - コントロールの重要度
<!ELEMENT CONTROL_LIST (CONTROL*)>
<!ELEMENT CONTROL (ORDER, CID, STATEMENT, CRITICALITY?, CATEGORY,
POSTURE)>
<!ELEMENT ORDER (#PCDATA)>
<!ELEMENT CID (#PCDATA)>
<!ELEMENT STATEMENT (#PCDATA)>
<!ELEMENT CRITICALITY (LABEL, VALUE)>
<!ELEMENT LABEL (#PCDATA)>
<!ELEMENT VALUE (#PCDATA)>
...
コントロール合格 / 不合格レポート
Report Share API またはユーザインタフェースから XML 形式または CSV 形式でコントロール合
格 / 不合格レポートをダウンロードした際に、コントロールの重要度が表示されるようになります。
XML 出力 :
...
<FILTERS>
<POLICY><![CDATA[Access Control & OS Security]]></POLICY>
<CID>8838</CID>
<CONTROL><![CDATA[Status of the '.rhosts' file(s) in user home
directories on the host]]></CONTROL>
<CRITICALITY>
<LABEL><![CDATA[SERIOUS]]></LABEL>
<VALUE>3</VALUE>
</CRITICALITY>
<ASSET_GROUP>
<TITLE><![CDATA[Compliance Hosts]]></TITLE>
<TOTAL_SCANIPS>23</TOTAL_SCANIPS>
<TOTAL_MAPDOMAINS>0</TOTAL_MAPDOMAINS>
<TOTAL_USERS>1</TOTAL_USERS>
<BUSINESS_IMPACT>
<RANK>4</RANK>
<IMPACT_TITLE><![CDATA[High]]></IMPACT_TITLE>
</BUSINESS_IMPACT>
<CVSS_ENVIRO_CDP><![CDATA[Not Defined]]></CVSS_ENVIRO_CDP>
<CVSS_ENVIRO_TD><![CDATA[Not Defined]]></CVSS_ENVIRO_TD>
<CVSS_ENVIRO_CR><![CDATA[Not Defined]]></CVSS_ENVIRO_CR>
<CVSS_ENVIRO_IR><![CDATA[Not Defined]]></CVSS_ENVIRO_IR>
<CVSS_ENVIRO_AR><![CDATA[Not Defined]]></CVSS_ENVIRO_AR>
</ASSET_GROUP>
<DISPLAY><![CDATA[Passed and Failed]]></DISPLAY>
<SORT_BY><![CDATA[IP Address]]></SORT_BY>
<POLICY_MODIFIED><![CDATA[09/11/2014 at 09:59:10 (GMT0700)]]></POLICY_MODIFIED>
</FILTERS>
...
Qualys API リリースノート
32
Policy Compliance - コントロールの重要度
DTD の更新 :
コントロール合格 / 不合格レポート DTD(control_pass_fail_report.dtd)に CRITICALITY 要素が
追加されました。
...
<!ELEMENT FILTERS (POLICY, CID, CONTROL, CRITICALITY?, ASSET_GROUP,
DISPLAY, SORT_BY, POLICY_MODIFIED)>
<!ELEMENT CID (#PCDATA)>
<!ELEMENT POLICY (#PCDATA)>
<!ELEMENT CONTROL (#PCDATA)>
<!ELEMENT CRITICALITY (LABEL, VALUE)>
<!ELEMENT LABEL (#PCDATA)>
<!ELEMENT VALUE (#PCDATA)>
<!ELEMENT DISPLAY (#PCDATA)>
<!ELEMENT SORT_BY (#PCDATA)>
<!ELEMENT POLICY_MODIFIED (#PCDATA)>
...
XML 形式のユーザ定義コントロール
UI からユーザ定義コントロールをインポートおよびエクスポートする際に使用されるユーザ定義
コントロールの XML スキーマ(ImportableControl.xsd)に、新しい CRITICALITY 要素が追加
されました。
XML 出力 :
...
<STATEMENT><![CDATA[User Directory Permissions]]></STATEMENT>
<CRITICALITY>
<LABEL><![CDATA[SERIOUS]]></LABEL>
<VALUE>3</VALUE>
</CRITICALITY>
<COMMENT><![CDATA[]]></COMMENT>
...
XSD の更新 :
...
<xs:element name="CONTROL">
<xs:complexType>
<xs:sequence>
<xs:element ref="CHECK_TYPE" maxOccurs="1" />
<xs:element ref="CATEGORY" minOccurs="0" maxOccurs="1" />
<xs:element ref="SUB_CATEGORY" minOccurs="0" maxOccurs="1" />
<xs:element ref="STATEMENT" maxOccurs="1" />
<xs:element ref="CRITICALITY" minOccurs="0" maxOccurs="1" />
<xs:element ref="COMMENT" minOccurs="0" maxOccurs="1" />
<xs:element ref="IGNORE_ERROR" maxOccurs="1" />
Qualys API リリースノート
33
Policy Compliance - コントロールの重要度
<xs:element ref="SCAN_PARAMETERS" maxOccurs="1" />
<xs:element ref="TECHNOLOGY_LIST" maxOccurs="1" />
<xs:element ref="REFERENCE_LIST" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
...
<xs:element name="CRITICALITY">
<xs:complexType>
<xs:sequence>
<xs:element ref="LABEL" minOccurs="0" maxOccurs="1" />
<xs:element ref="VALUE" minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
...
Qualys API リリースノート
34
Policy Compliance - EC2 スキャンのサポート
Policy Compliance - EC2 スキャンのサポート
PC スキャン API v2(/api/2.0/fo/scan/compliance/、action=launch を指定)を
使用して、Amazon Web Services アカウントにある Amazon EC2 ホストで EC2 コンプライアン
ススキャンを開始できるようになりました。
Qualys を使用した Amazon EC2 スキャンワークフローは、AWS によって事前認証されています。
詳細については、Qualys コミュニティの Help Center for Amazon Web Services(英語)を参照し
てください。
考慮事項
- アカウントで、Policy Compliance(PC)、EC2 スキャン、EC2 コネクタの各機能を有効にする
必要があります。
- マネージャユーザのみが EC2 スキャンを開始できます。
- AWS Marketplace で公開されている Qualys のアプライアンス用 AMI を使用して、Amazon EC2
の Scanner Appliance(仮想アプライアンス)を設定します。設定するには、ユーザインタフェー
スにログインして、「VM」→「Scans」→「Appliances」を選択し、「New」→「Virtual Scanner
Appliance」を選択して、表示される手順に従います。必ず、
「Pre-Authorized Scanning(事前認証
されたスキャン)
」アプライアンスを導入してください。
- 設定した EC2 コネクタが必要です。ユーザインタフェースで、「AM(Asset Management)」→
「Connectors」を選択して、
「Actions」→「Create EC2 Connector」を選択します。スキャンする
EC2 ホストを選択して、アセットタグを割り当てます(ヒント - EC2 スキャンを開始する場合は、
スキャン対象に EC2 ホストタグを選択します)
。
API リクエスト :
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl" -X "POST" -d
"action=launch&scan_title=My+EC2+Scan+via+API&connector_name=EC2Connector-Lab&ec2_endpoint=us-east1&target_from=tags&tag_include_selector=any&tag_set_by=id&tag_set_include
=270325&option_id=61769&iscanner_name=my-ec2-scanner"
"https://qualysapi.qualys.com/api/2.0/fo/scan/compliance/"
XML 出力 :
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE SIMPLE_RETURN SYSTEM
"https://qualysapi.qualys.com/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
<REQUEST>
<DATETIME>2014-06-24T10:10:51Z</DATETIME>
<USER_LOGIN>USERNAME</USER_LOGIN>
<RESOURCE>https://qualysapi.qualys.com/api/2.0/fo/scan/compliance/
</RESOURCE>
Qualys API リリースノート
35
Policy Compliance - EC2 スキャンのサポート
</REQUEST>
<RESPONSE>
<DATETIME>2014-06-24T10:10:57Z</DATETIME>
<TEXT>New compliance scan launched</TEXT>
<ITEM_LIST>
<ITEM>
<KEY>ID</KEY>
<VALUE>2222345</VALUE>
</ITEM>
<ITEM>
<KEY>REFERENCE</KEY>
<VALUE>compliance/1347771234.36444</VALUE>
</ITEM>
</ITEM_LIST>
</RESPONSE>
</SIMPLE_RETURN>
入力パラメータ :
EC2 コンプライアンススキャンを開始するために必要な入力パラメータを以下に示します。これら
のパラメータの詳細については、
『Qualys API v2 User Guide』の第 3 章にあるスキャン開始パラ
メータの説明を参照してください。
タイプ
パラメータリスト
リクエスト
action=launch(必須)、echo_request
スキャンタイトル
scan_title
EC2 環境
connector_name(必須)、ec2_endpoint(必須)
オプションプロファイル
option_id または option_title
Scanner Appliance
iscanner_id または iscanner_name
対象のホスト
target_from=tags(必須)
タグを使用してスキャン対象の EC2 ホストを選択します。
use_ip_nt_range_tags=0
デフォルトでは「0」に設定されています(重要 - EC2 スキャ
ンでは「1」に設定することはできません)。
これらのタグパラメータは、タグの選択に使用されます。
tag_set_include={tag1,tag2,...}(必須)
tag_set_exclude={tag1,tag2,...}(オプション)
tag_include_selector={any|all}(太字がデフォルト)
tag_exclude_selector={any|all}(太字がデフォルト)
tag_set_by={id|name}(太字がデフォルト)
Qualys API リリースノート
36
Asset Management - Policy Compliance のアセットのアクティブ化
Asset Management - Policy Compliance のアセットの
アクティブ化
アセット管理 API v2 が更新されました。アセットのアクティブ化 API(/activate/am/asset/)によ
り、Policy Compliance スキャンおよびレポートのアセットをアクティブ化することができるよう
になりました。新しく作成したホストをアクティブ化することで、Policy Compliance(PC)モ
ジュールで使用できるようになります。
PC アセット用 URL
https://<baseurl>/qps/rest/2.0/activate/am/asset/<id>?module=QWEB_PC
または
https://<baseurl>/qps/rest/2.0/activate/am/asset?module=QWEB_PC
メソッド
POST
パーミッション :
フルスコープを付与されたマネージャ
フルスコープを付与されていないユーザには、次のアカウント設定が必要です。1)スコープ
に対象のアセットを含める。かつ、2)パーミッションに
アクセスパーミッション「API Access」を含める。
PC アセットの場合は、Policy Compliance(PC)モジュールを有効にする必要があります。
「My PC Assets」タグを持つアセットをアクティブ化します。
リクエスト :
curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST"
--data-binary @"https://qualysapi.qualys.com/qps/rest/2.0/activate/am/asset?modul
e=QWEB_PC" < file.xml
リクエスト POST データ(file.xml):
<ServiceRequest>
<filters>
<Criteria field="tagName" operator="EQUALS">My PC
Assets</Criteria>
</filters>
</ServiceRequest>
Qualys API リリースノート
37
Asset Management - Policy Compliance のアセットのアクティブ化
応答 :
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
xsi:noNamespaceSchemaLocation="https://qualysapi.qualys.com/qps/xs
d/2.0/am/asset.xsd">
<responseCode>SUCCESS</responseCode>
<count>1</count>
<data>
<Asset>
<id>1972521</id>
<name>Test Asset</name>
<created>2013-12-11T05:12:45Z</created>
<modified>2014-08-04T23:55:54Z</modified>
<type>HOST</type>
<tags>
<list>
<SimpleTag>
<id>12345</id>
<name>Export to VM</name>
</SimpleTag>
<list>
</tags>
<sourceInfo>
<list>
<Ec2AssetSourceSimple>
<firstDiscovered>2014-02-06T19:14:50Z</firstDiscovered>
<lastUpdated>2014-08-06T19:14:50Z</lastUpdated>
<assetId>1972521</assetId>
<availabilityZone>us-east</availabilityZone>
<privateDnsName>ip-10-90-073.qualys.com</privateDnsName>
<instanceId>i-8b545eef</instanceId>
<instanceType>t1.micro</instanceType>
<imageId>ami-03ad6e6a</imageId>
<privateIpAddress>127.0.0.1</privateIpAddress>
<monitoringEnabled>false</monitoringEnabled>
</Ec2AssetSourceSimple>
</list>
</sourceInfo>
<openPort>
Qualys API リリースノート
38
Asset Management - Policy Compliance のアセットのアクティブ化
<list/>
</openPort>
<software>
<list/>
</software>
<vuln>
<list/>
</vuln>
</Asset>
</data>
</ServiceResponse>
Qualys API リリースノート
39