Exemple d'extension d'authentificateur de périphérique Edge
L'exemple ci-dessous illustre comment une extension d'authentificateur de périphérique Edge peut être élaborée en vue d'utiliser les réclamations de sécurité émises par le périphérique.
Cet exemple illustre les opérations suivantes :
• Etend la classe SecurityClaimsAuthenticator depuis l'API ThingWorx Platform pour implémenter la logique personnalisée de traitement dans les méthodes matchesAuthRequest et authenticate.
• Dans la méthode matchesAuthRequest :
◦ Les réclamations de sécurité entrantes sont contrôlées pour vérifier si elles contiennent une réclamation secretTokenKey.
◦ Si parmi les réclamations se trouve une réclamation secretTokenKey, la méthode renvoie la valeur Vrai à la plateforme, indiquant que cet authentificateur doit être utilisé pour valider les réclamations de sécurité.
• Dans la méthode authenticate :
◦ Obtention de secretTokenKey.
◦ Si la réclamation secretTokenKey n'est ni nulle ni vide, et si sa valeur correspond à la valeur attendue de MySecretKey, la méthode renvoie la valeur de whoTheySaidTheyWere, qui est associée à un utilisateur.
◦ Si l'utilisateur fourni existe, il est authentifié sur 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");
}
}