org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator クラス

org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator の継承関係図

org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator 連携図

公開メンバ関数
void	authenticate (final AuthenticationFlowContext context)
void	action (final AuthenticationFlowContext context)
boolean	requiresUser ()
boolean	configuredFor (final KeycloakSession session, final RealmModel realm, final UserModel user)
void	setRequiredActions (final KeycloakSession session, final RealmModel realm, final UserModel user)
void	close ()

限定公開メンバ関数
void	userSuccessAction (AuthenticationFlowContext context, UserModel user)
void	userDisabledAction (AuthenticationFlowContext context, RealmModel realm, UserModel user)
void	nullUserAction (final AuthenticationFlowContext context, final RealmModel realm, final String user)
void	notValidCredentialsAction (final AuthenticationFlowContext context, final RealmModel realm, final UserModel user)

非公開メンバ関数
String []	getUsernameAndPassword (final HttpHeaders httpHeaders)

静的非公開変数類
static final String	BASIC = "Basic"
static final String	BASIC_PREFIX = BASIC + " "

詳解

関数詳解

action()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.action ( final AuthenticationFlowContext  context )

inline

                                                                {

    }

authenticate()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.authenticate ( final AuthenticationFlowContext  context )

inline

                                                                      {
        final HttpRequest httpRequest = context.getHttpRequest();
        final HttpHeaders httpHeaders = httpRequest.getHttpHeaders();
        final String[] usernameAndPassword = getUsernameAndPassword(httpHeaders);

        context.attempted();

        if (usernameAndPassword != null) {
            final RealmModel realm = context.getRealm();
            final String username = usernameAndPassword[0];
            final UserModel user = context.getSession().users().getUserByUsername(username, realm);

            if (user != null) {
                final String password = usernameAndPassword[1];
                final boolean valid = context.getSession().userCredentialManager().isValid(realm, user, UserCredentialModel.password(password));

                if (valid) {
                    if (user.isEnabled()) {
                        userSuccessAction(context, user);
                    } else {
                        userDisabledAction(context, realm, user);
                    }
                } else {
                    notValidCredentialsAction(context, realm, user);
                }
            } else {
                nullUserAction(context, realm, username);
            }
        }
    }

close()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.close ( )

inline

                        {

    }

configuredFor()

boolean org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.configuredFor ( final KeycloakSession  session, final RealmModel  realm, final UserModel  user  )

inline

                                                                                                              {
        return false;
    }

getUsernameAndPassword()

String [] org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.getUsernameAndPassword ( final HttpHeaders  httpHeaders )

inlineprivate

                                                                           {
        final List<String> authHeaders = httpHeaders.getRequestHeader(HttpHeaders.AUTHORIZATION);

        if (authHeaders == null || authHeaders.size() == 0) {
            return null;
        }

        String credentials = null;

        for (final String authHeader : authHeaders) {
            if (authHeader.startsWith(BASIC_PREFIX)) {
                final String[] split = authHeader.trim().split("\\s+");

                if (split == null || split.length != 2) return null;

                credentials = split[1];
            }
        }

        try {
            String val = new String(Base64.decode(credentials));
            int seperatorIndex = val.indexOf(":");
            if(seperatorIndex == -1) return new String[]{val};
            String user = val.substring(0, seperatorIndex);
            String pw = val.substring(seperatorIndex + 1);
            return new String[]{user,pw};
        } catch (final IOException e) {
            throw new RuntimeException("Failed to parse credentials.", e);
        }
    }

notValidCredentialsAction()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.notValidCredentialsAction ( final AuthenticationFlowContext  context, final RealmModel  realm, final UserModel  user  )

inlineprotected

                                                                                                                                    {
        context.getEvent().user(user);
        context.getEvent().error(Errors.INVALID_USER_CREDENTIALS);
        context.failure(AuthenticationFlowError.INVALID_USER, Response.status(Response.Status.UNAUTHORIZED)
                .header(HttpHeaders.WWW_AUTHENTICATE, BASIC_PREFIX + "realm=\"" + realm.getName() + "\"")
                .build());
    }

nullUserAction()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.nullUserAction ( final AuthenticationFlowContext  context, final RealmModel  realm, final String  user  )

inlineprotected

                                                                                                                      {
        // no-op by default
    }

requiresUser()

boolean org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.requiresUser ( )

inline

                                  {
        return false;
    }

setRequiredActions()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.setRequiredActions ( final KeycloakSession  session, final RealmModel  realm, final UserModel  user  )

inline

                                                                                                                {

    }

userDisabledAction()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.userDisabledAction ( AuthenticationFlowContext  context, RealmModel  realm, UserModel  user  )

inlineprotected

                                                                                                           {
        userSuccessAction(context, user);
    }

userSuccessAction()

void org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.userSuccessAction ( AuthenticationFlowContext  context, UserModel  user  )

inlineprotected

                                                                                        {
        context.getAuthenticationSession().setAuthenticatedUser(user);
        context.success();
    }

メンバ詳解

BASIC

final String org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.BASIC = "Basic"

staticprivate

BASIC_PREFIX

final String org.keycloak.protocol.saml.profile.ecp.authenticator.HttpBasicAuthenticator.BASIC_PREFIX = BASIC + " "

staticprivate

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/protocol/saml/profile/ecp/authenticator/HttpBasicAuthenticator.java