従来のREST APIを使用する

従来のREST APIを使用する場合

注意 Server & Workload Protection APIには、エンドポイントが継続的に追加されています。この表の変更を定期的に確認してください。

REST APIを使用するための環境の設定

1. Deep Security WebサービスSDKのダウンロード
2. REST APIクライアントが使用できるユーザアカウントを作成する

WebサービスSDKのダウンロード

Webサービスの役割とユーザの作成

1. Server & Workload Protection コンソールで、次の場所に移動します。[管理] → [ユーザ管理] → [役割] 。
2. [新規]をクリックします。
3. [Workload Security Managerユーザインタフェースへのアクセスを許可] の選択を解除し、 [WebサービスAPIへのアクセスを許可]を選択します。
4. 他のすべての設定が完了したら、 [保存]をクリックします。
5. 詳細に従ってアカウントに参加するようユーザを招待するここ。
6. ユーザに必要なプロパティを指定します。 [役割] プロパティで、作成した役割を選択します。
7. 新しいユーザアカウントのユーザ名とパスワードを書き留めます。

REST APIクライアントアプリケーションの開発

基本的なAPIアクセス

セッションの管理

• 不要になったAPIセッションを終了します。 Server & Workload Protection は、一度にアクティブにできるセッションの数を制限します。同時セッションの最大数に達しないように、アプリケーションはセッションを終了する必要があります。を呼び出します。/rest/authentication/logoutセッションを終了するURL。
• 設定可能な期間が経過するとセッションがタイムアウトします。ユーザごとに許可される同時セッション数とセッションタイムアウトを変更するには、[管理] → [システム設定] → [セキュリティ] 。

提供されたJava REST APIクライアントを使用する

Javaコードの例

import javax.ws.rs.core.Response.Status; import org.jboss.resteasy.client.ClientResponse; import org.jboss.resteasy.client.ClientResponseFailure; import org.jboss.resteasy.client.ProxyFactory; import org.jboss.resteasy.client.core.executors.ApacheHttpClient4Executor; import org.jboss.resteasy.plugins.providers.RegisterBuiltin; import org.jboss.resteasy.spi.ResteasyProviderFactory; import com.trendmicro.ds.platform.rest.api.IAuthenticationAPI; import com.trendmicro.ds.platform.rest.message.error.ErrorMessage; import com.trendmicro.ds.platform.rest.object.DSCredentials; public class AuthenticateSample { public static void main(String[] args) { // URL for the REST API. Change this as appropriate. String restApiUrl = "https://10.0.0.5:4119/rest"; // The user name to use for authentication. Change this as appropriate. String username = "admin"; // The user's password. Change this as appropriate. String password = "supersecretpassword"; // Variable to store the session identifier (SID). String sID = null; // RESTEasy client framework initialization that only needs to be done once per VM RegisterBuiltin.register(ResteasyProviderFactory.getInstance()); // An object that will execute HTTP requests ApacheHttpClient4Executor executor = new ApacheHttpClient4Executor(); // Create the object that will communicate with the authentication API. IAuthenticationAPI authClient = ProxyFactory.create(IAuthenticationAPI.class, restApiUrl, executor); // Create the object to pass to the authentication call. DSCredentials credentials = new DSCredentials(); credentials.setUserName(username); credentials.setPassword(password); try { System.out.println("Attempting to authenticate to Server & Workload Protection REST API..."); sID = authClient.login(credentials); System.out.println("Authentication successful."); System.out.println("Authentication session ID string received: " + sID); } catch (ClientResponseFailure e) { // This is a special type of exception that means the server threw // an exception because there was a problem with the credentials. // It's important to handle these exceptions explicitly or the // connection to the server won't be released back in to the // underlying connection pool, meaning any subsequent API calls would fail. // See the RESTEasy Client Framework documentation for more details. ClientResponse<?> clientResponse = e.getResponse(); // Try to parse the error response in to an instance of the special // ErrorMessage class and display the result. Status status = clientResponse.getResponseStatus(); System.out.println("Server returned error status code " + status.getStatusCode() + " (" + status + ")"); ErrorMessage errorMessage = clientResponse.getEntity(ErrorMessage.class); System.out.println("Returned error message: " + errorMessage.getMessage()); } catch (Exception e) { // Some other error happened, most likely related to network communication problems. System.out.println("There was an error during authentication."); e.printStackTrace(); } finally { if (sID != null) { // Make sure to always log out. System.out.println(""); System.out.println("Ending session..."); authClient.endSession(sID); System.out.println("End session successful."); // make sure the session ID isn't accidentally re-used. sID = null; } } // Cleanup: force the HTTP Client to close any open sockets executor.close(); } }Server & Workload Protection REST API...");
				sID = authClient.login(credentials);
	
				System.out.println("Authentication successful.");
				System.out.println("Authentication session ID string received: " + sID);

			} catch (ClientResponseFailure e) {
				// This is a special type of exception that means the server threw
				// an exception because there was a problem with the credentials.
				// It's important to handle these exceptions explicitly or the
				// connection to the server won't be released back in to the
				// underlying connection pool, meaning any subsequent API calls would fail.
				// See the RESTEasy Client Framework documentation for more details. 
				ClientResponse<?> clientResponse = e.getResponse();

				// Try to parse the error response in to an instance of the special
				// ErrorMessage class and display the result.
				Status status = clientResponse.getResponseStatus();
				System.out.println("Server returned error status code " + status.getStatusCode() + " (" + status + ")");
				ErrorMessage errorMessage = clientResponse.getEntity(ErrorMessage.class);
				System.out.println("Returned error message: " + errorMessage.getMessage());

			} catch (Exception e) {
				// Some other error happened, most likely related to network communication problems.
				System.out.println("There was an error during authentication.");
				e.printStackTrace();
			
			} finally {
				if (sID != null) {
					// Make sure to always log out.
					System.out.println("");
					System.out.println("Ending session...");
					authClient.endSession(sID);
					System.out.println("End session successful.");
					// make sure the session ID isn't accidentally re-used.
					sID = null;
				}
			}
		
			// Cleanup: force the HTTP Client to close any open sockets
			executor.close();

	}
	
}

サンプルJavaコードの使用

1. Eclipseで、[ファイル] → [インポート] 。
2. 選択[一般] → [既存のプロジェクトをワークスペースに]インポート元。
3. [参照] をクリックし、 Deep Security Web Services SDKのサンプルフォルダをルートとして選択します。
4. [REST APIのサンプル] プロジェクトが選択されていることを確認し、 [完了]をクリックします。

HTTPステータスコード

エラー応答

{ "error": { "message": "The Activation Code KA47-R947M-KDLUZ-A8WLF-WM6A3-LOL is invalid." } }

<error> <message>Error message string</message> </error>

ヒント XML対応ボディの使用を強制するには、Acceptの値を使用してリクエストにヘッダを追加します。application/xml 。

javax.ws.rs.core.Responseを返すAPI呼び出し

org.jboss.resteasy.client.ClientResponse<?> clientResponse = (ClientResponse<?>)apiObject.methodThatReturnsResponse(methodParameters); clientResponse.releaseConnection();

特別な考慮事項

クエリパラメータに日付を指定する