認証

org.iplass.mtp.impl.auth.authenticate.AuthenticationProvider
org.iplass.mtp.impl.auth.authenticate.AuthenticationProviderBase

package org.iplass.mtp.sample.auth;

import java.util.HashMap;
import java.util.Map;

import org.iplass.mtp.auth.User;
import org.iplass.mtp.auth.login.Credential;
import org.iplass.mtp.auth.login.IdPasswordCredential;
import org.iplass.mtp.impl.auth.AuthService;
import org.iplass.mtp.impl.auth.authenticate.AccountHandle;
import org.iplass.mtp.impl.auth.authenticate.AccountManagementModule;
import org.iplass.mtp.impl.auth.authenticate.AuthenticationProvider;
import org.iplass.mtp.impl.auth.authenticate.AuthenticationProviderBase;
import org.iplass.mtp.impl.auth.authenticate.UserEntityResolver;
import org.iplass.mtp.spi.Config;

public class SampleAuthenticationProvider extends AuthenticationProviderBase {

    /**
     * 認証プロバイダーの初期化処理を実装します。
     */
    @Override
    public void inited(AuthService service, Config config) {

        //独自のUserEntityResolverを設定 (1)
        if (getUserEntityResolver() == null) {
            SampleUserEntityResolver uer = new SampleUserEntityResolver();
            setUserEntityResolver(uer);
        }

        super.inited(service, config);
    }

    /**
     * ログイン処理を実装します。
     *
     * ログインが成功した場合は、AccountHandleを実装したクラスを返します。
     */
    @Override
    public AccountHandle login(Credential credential) { (2)
        IdPasswordCredential ipc = null;
        if (credential instanceof IdPasswordCredential) {
            ipc = (IdPasswordCredential) credential;
        } else {
            //違う場合はこのプロバイダでは認証しないので、nullを返す
            return null;
        }

        //認証処理の実装
        //ここは、認証するデータソースにあわせてそれぞれで実装します
        if (ipc.getId().equals("xxxx") && ipc.getPassword().equals("yyyy")) {
            //認証が成功した場合は、AccountHandleを実装したクラスのインスタンスを返します

            //AccountHandleに、ユーザー情報として持たせたい情報を設定します
            Map<String, Object> attributeMap = new HashMap<>();
            attributeMap.put("name", "test1");
            attributeMap.put("mail", "test@mail.com");

            return new SampleAccountHandle(ipc.getId(), attributeMap);
        }

        //認証失敗なのでnullを返す
        return null;
    }

    /**
     * ログアウト処理を実装します。
     */
    @Override
    public void logout(AccountHandle user) { (3)
        if (user instanceof SampleAccountHandle) {
            //対象のAccountHandleであれば、ログアウト時に必要な処理を実行
        }
    }

    /**
     * アカウント情報の更新可否、更新処理を管理するAccountManagementModuleを返します。
     */
    @Override
    public AccountManagementModule getAccountManagementModule() { (4)

        /*
         * この例では、AuthenticationProviderBaseで定義されている認証情報が変更不可なものを利用しています。
         * もし更新も可能にする場合は、AccountManagementModuleを実装したクラスを返します。
         */
        return AuthenticationProviderBase.NO_UPDATABLE_AMM;
    }

    /**
     * 対象とするCredentialを実装したクラス返します。
     */
    @Override
    public Class<? extends Credential> getCredentialType() {

        /*
         * この例では、ID、パスワードをもつIdPasswordCredentialを利用しています。
         * もし他の属性で認証したい場合は、Credentialを実装したクラスを返します。
         */
        return IdPasswordCredential.class;
    }

    /**
     * このプロバイダーでログインが成功した場合に保持するアカウント情報を管理するクラスを返します。
     */
    @Override
    protected Class<? extends AccountHandle> getAccountHandleClassForTrust() { (5)
        return SampleAccountHandle.class;
    }


    /**
     * ログインしたアカウント情報を保持するクラスです。
     */
    public class SampleAccountHandle implements AccountHandle { (6)

        private static final long serialVersionUID = 7558415988260650638L;

        /** 変更不可なユニークKEY */
        private String accountId;

        /** アカウントの属性として保持したい値 */
        private Map<String, Object> attributeMap;

        /** これは何番目のプロバイダーかの情報を保持するものです。基盤側で設定されるので保持してください */
        private int authenticationProviderIndex;

        public SampleAccountHandle(String accountId, Map<String, Object> attributeMap) {
            this.accountId = accountId;
            this.attributeMap = attributeMap;
        }

        @Override
        public boolean isAccountLocked() {
            return false;
        }

        @Override
        public boolean isExpired() {
            return false;
        }

        @Override
        public boolean isInitialLogin() {
            return false;
        }

        /*
         * 認証後に、色々な処理でアカウントの認証情報が求められた場合の認証情報を返します。
         * パスワード情報は認証時にしか使わないためAccountHandleには保持せずに、ここではセットしていません。
         */
        @Override
        public Credential getCredential() {
            return new IdPasswordCredential(accountId, null);
        }

        @Override
        public String getUnmodifiableUniqueKey() {
            return accountId;
        }

        @Override
        public Map<String, Object> getAttributeMap() {
            if(attributeMap == null){
                attributeMap = new HashMap<String, Object>();
            }
            return attributeMap;
        }

        @Override
        public void setAuthenticationProviderIndex(int authenticationProviderIndex) {
            this.authenticationProviderIndex = authenticationProviderIndex;
        }

        @Override
        public int getAuthenticationProviderIndex() {
            return authenticationProviderIndex;
        }

    }

    /**
     * アカウント情報からUserエンティティを生成するクラスです。
     */
    public class SampleUserEntityResolver implements UserEntityResolver { (7)

        @Override
        public void inited(AuthService service, AuthenticationProvider provider) {
        }

        /**
         * パラメータとして渡されたアカウント情報をもとにUserエンティティを返します。
         *
         * Userエンティティとしてデータを管理している場合はUserエンティティを検索して返しますが、
         * Userエンティティとして管理していない場合はここでUserエンティティを生成して返すように実装します。
         */
        @Override
        public User searchUser(AccountHandle account) {

            User user = new User();

            //ここではアカウント情報としてユニークな値をOIDに設定します
            user.setOid(account.getUnmodifiableUniqueKey());

            user.setAccountId(account.getCredential().getId());
            user.setName(account.getCredential().getId());

            //ここではaccountに設定された属性をUserエンティティに設定しています
            if (account.getAttributeMap() != null) {
                account.getAttributeMap().entrySet().stream().forEach(e -> {
                    user.setValue(e.getKey(), e.getValue());
                });
            }
            return user;
        }

        @Override
        public String getUnmodifiableUniqueKeyProperty() {
            //ユニークなKEYとなるプロパティ名を返します
            //OIDにユニークなKEYを設定しているので、OIDを返します。
            return User.OID;
        }

    }
}