Edge デバイス認証システム拡張機能の例
以下の例は、Edge から送信されるセキュリティ要求を使用する Edge デバイス認証システム拡張機能を開発する方法を示しています。
この例では、以下のことが行われます。
• ThingWorx Platform API から SecurityClaimsAuthenticator クラスを拡張して、matchesAuthRequest メソッドおよび authenticate メソッド内のカスタム処理ロジックを実装します。
• matchesAuthRequest メソッド内:
◦ 受信セキュリティ要求を検査して、secretTokenKey 要求が含まれているかどうか調べます。
◦ セキュリティ要求に secretTokenKey 要求が含まれている場合、メソッドはプラットフォームに true を返します。これは、この認証システムを使用してセキュリティ要求を検証する必要があることを示しています。
• authenticate メソッド内:
◦ secretTokenKey を取得します。
◦ secretTokenKey が Null でも空でもなく、その値が MySecretKey の予期される値と一致する場合、メソッドは whoTheySaidTheyWere の値を返します。この値はユーザーです。
◦ 提示されたユーザーが存在する場合、これらは ThingWorx Platform で認証されます。
package your.company.thingworx.authenticator;
import com.thingworx.communications.common.SecurityClaims;
import com.thingworx.security.authentication.AuthenticatorException;
import com.thingworx.security.authentication.SecurityClaimsAuthenticator;
/**
* Custom edge security authenticators are based around the "SecurityClaims"
* class. This class is at its essence a wrapper around a map. To use the
* map, one provides
*/
public class CustomEdgeAuthenticator extends SecurityClaimsAuthenticator {
private static final long serialVersionUID = 1L;
/**
* The matchesAuthRequest method is the indicator that this
* authenticator should be used to verify the SecurityClaims object
* presented. This method allows the author to make a determination
* about the claims provided by inspecting the information therein and
* decide if this authenticator
* should be used to try to verify the claims provided or not.
*
* @param SecurityClaims object containing the corresponding security
* information @return boolean indicating the authenticator should be
* used to verify the SecurityClaims provided
*/
@Override
public boolean matchesAuthRequest(SecurityClaims securityClaims) throws
AuthenticatorException {
//in this simple implementation we are looking for a 'secretTokenKey'
//claim. If one is present in the securityClaims object supplied -
//this SecurityClaimsAuthenticator should be used
return securityClaims.getClaims().containsKey("secretTokenKey");
}
/**
* This is the method that must be implemented to ensure the presented
* SecurityClaims are valid.
*
* @param SecurityClaims object containing the corresponding security
* information @return String indicating the corresponding user identity
* which the SecurityClaims represent.
*/
@Override
public String authenticate(SecurityClaims securityClaims) throws
AuthenticatorException {
String secretTokenValue = securityClaims.getClaims().get
("secretTokenKey");
if(secretTokenValue != null && secretTokenValue.trim().length() > 0)
{
//the secretTokenValue was provided - verify it is the proper
value!
if("MySecretKey".equals(secretTokenValue)) {
//Only when all these checks are complete will we consider
// the auth request to be valid. Here we have permitted the
// user to tell the platform "who" they are via the
// SecurityClaims
//This is a naieve example - and is for illustrative
// purposes only.
return securityClaims.getClaims().get("whoTheySaidTheyWere");
}
}
//throw a generic exception - and do not leak important information
//to the caller
throw new AuthenticatorException("The claims provided are incorrect");
}
}