/* * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology. * * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in * compliance with the Licence. You may obtain a copy of the Licence at: * https://joinup.ec.europa.eu/news/understanding-eupl-v12 * * Unless required by applicable law or agreed to in writing, software distributed under the Licence * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the Licence for the specific language governing permissions and limitations under * the Licence. * * This product combines work with different licenses. See the "NOTICE" text file for details on the * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative * works that you distribute must include a readable copy of the "NOTICE" text file. */ package at.gv.egiz.eaaf.core.api.idp; import java.util.Date; import at.gv.egiz.eaaf.core.api.idp.auth.data.IIdentityLink; /** * Service-Provider specific authentication-data. * * @author tlenz * */ public interface IAuthData { /** * BaseId transfer policy. * * @return true if baseID transfer to service provider is allowed, otherwise * false */ boolean isBaseIdTransferRestrication(); /** * Identifier of the IDP that authenicates the user. * * @return */ String getAuthenticationIssuer(); /** * Timestamp of the authentication process. * * @return */ Date getAuthenticationIssueInstant(); /** * Get string formated timestamp of the authentication process. * * @return */ String getAuthenticationIssueInstantString(); /** * Familyname of the user. * * @return */ String getFamilyName(); /** * Givenname of the user. * * @return */ String getGivenName(); /** * Date of birth of the user as "yyyy-MM-dd". * *
Attention: MM and dd can also be 00 in case of an unknown date
* * @return date of birth or null no data of birth is available */ String getDateOfBirth(); /** * Get date of birth with a specific date pattern. * *Attention: If birthday has un unusal form like MM and dd are 00 * a transformation CAN NOT be possible
* * @param pattern Date pattern, like "yyyy-MM-dd" e.g. * @return Formatted birthday ornull
if date can not be transformed
*/
String getDateOfBirthFormated(String pattern);
/**
* Get the encrypted SourceId (vSZ) from new E-ID scheme.
*
* @return
*/
String getEncryptedSourceId();
/**
* Get the type identifier of encrypted SourceId.
*
* @return
*/
String getEncryptedSourceIdType();
/**
* Return LoA for this user authentication.
*
* @return eIDAS LoA URI
*/
String getEidasQaaLevel();
/**
* Indicates that the user is a foreigner.
*
* @return true if the user is foreigner, otherwise false
*/
boolean isForeigner();
/**
* Code of the citizen country of the authenticated user.
*
* @return
*/
String getCiticenCountryCode();
/**
* Indicate that the authentication was done by using an active single sign-on
* session.
*
* @return true if it an SSO session was used, otherwise false
*/
boolean isSsoSession();
/**
* Date, up to which the SSO that was used for authentication is valid to.
*
* @return
*/
Date getSsoSessionValidTo();
/**
* SessionIndex, if it was an reauthentication on a service provider by using
* the same SSO session.
*
* @return
*/
String getSessionIndex();
/**
* SAML2 NameID for the user.
*
* @return
*/
String getNameID();
/**
* Format of the SAML2 NameID.
*
* @return
*/
String getNameIdFormat();
/**
* Get generic information for this authenticated user.
*
* @param key Identifier for the generic data
* @param clazz Type of the generic data
* @param