package org.forgerock.openam.authentication.modules.oath.plugins;
/*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2015 ForgeRock AS.
*/
import com.sun.identity.authentication.spi.AuthLoginException;
/**
* Provided as an extension point to allow customised transformation of the OATH shared secret attribute.
* @supported.all.api
*/
public interface SharedSecretProvider {
/**
* Takes the non-empty shared secret that is retrieved for a user and implements any processing needed for to
* return the byte array of the string value.
* the module will fail.
*
* @param secretKey shared secret value
* @return a byte array of the shared secret - this should not be null
* @throws AuthLoginException if an error occurs transforming the value
* and should cause the module to fail.
*/
byte[] getSharedSecret(String secretKey) throws AuthLoginException;
}