org.keycloak.authentication.ConsoleDisplayMode クラス

org.keycloak.authentication.ConsoleDisplayMode 連携図

クラス
class	HeaderBuilder

公開メンバ関数
LoginFormsProvider	form ()
Response	message (String msg, String... params)
Response	text (String text)
Response	response ()
HeaderBuilder	header ()

静的公開メンバ関数
static Response	browserRequired (KeycloakSession session)
static Response	browserContinue (KeycloakSession session, String callback)
static ConsoleDisplayMode	challenge (RequiredActionContext context)
static ConsoleDisplayMode	challenge (AuthenticationFlowContext context)
static HeaderBuilder	header (RequiredActionContext context)
static HeaderBuilder	header (AuthenticationFlowContext context)

限定公開メンバ関数
LoginFormsProvider	formInternal ()

限定公開変数類
RequiredActionContext	requiredActionContext
AuthenticationFlowContext	flowContext
HeaderBuilder	header

関数
	ConsoleDisplayMode (RequiredActionContext requiredActionContext)
	ConsoleDisplayMode (AuthenticationFlowContext flowContext)

詳解

This class encapsulates a proprietary HTTP challenge protocol designed by keycloak team which is used by text-based console clients to dynamically render and prompt for information in a textual manner. The class is a builder which can build the challenge response (the header and response body).

When doing code to token flow in OAuth, server could respond with

401 WWW-Authenticate: X-Text-Form-Challenge callback="http://localhost/..." param="username" label="Username: " mask=false param="password" label="Password: " mask=true Content-Type: text/plain

Please login with your username and password

The client receives this challenge. It first outputs whatever the text body of the message contains. It will then prompt for username and password using the label values as prompt messages for each parameter.

After the input has been entered by the user, the client does a form POST to the callback url with the values of the input parameters entered.

The server can challenge with 401 as many times as it wants. The client will look for 302 responses. It will will follow all redirects unless the Location url has an OAuth "code" parameter. If there is a code parameter, then the client will stop and finish the OAuth flow to obtain a token. Any other response code other than 401 or 302 the client should abort with an error message.

構築子と解体子

ConsoleDisplayMode() [1/2]

org.keycloak.authentication.ConsoleDisplayMode.ConsoleDisplayMode ( RequiredActionContext  requiredActionContext )

inlinepackage

                                                                    {
        this.requiredActionContext = requiredActionContext;
    }

ConsoleDisplayMode() [2/2]

org.keycloak.authentication.ConsoleDisplayMode.ConsoleDisplayMode ( AuthenticationFlowContext  flowContext )

inlinepackage

                                                              {
        this.flowContext = flowContext;
    }

関数詳解

browserContinue()

static Response org.keycloak.authentication.ConsoleDisplayMode.browserContinue ( KeycloakSession  session, String  callback  )

inlinestatic

Browser is required to continue login. This will prompt client on whether to continue with a browser or abort.

引数

session
callback

戻り値

                                                                                     {
        String browserContinueMsg = session.getProvider(LoginFormsProvider.class).getMessage("browserContinue");
        String browserPrompt = session.getProvider(LoginFormsProvider.class).getMessage("browserContinuePrompt");
        String answer = session.getProvider(LoginFormsProvider.class).getMessage("browserContinueAnswer");

        String header = "X-Text-Form-Challenge callback=\"" + callback + "\"";
        header += " browserContinue=\"" + browserPrompt + "\" answer=\"" + answer + "\"";
        return Response.status(Response.Status.UNAUTHORIZED)
                .header("WWW-Authenticate", header)
                .type(MediaType.TEXT_PLAIN)
                .entity("\n" + browserContinueMsg + "\n").build();
    }

browserRequired()

static Response org.keycloak.authentication.ConsoleDisplayMode.browserRequired ( KeycloakSession  session )

inlinestatic

Browser is required to login. This will abort client from doing a console login.

引数

session

戻り値

                                                                    {
        return Response.status(Response.Status.UNAUTHORIZED)
                .header("WWW-Authenticate", "X-Text-Form-Challenge browserRequired")
                .type(MediaType.TEXT_PLAIN)
                .entity("\n" + session.getProvider(LoginFormsProvider.class).getMessage("browserRequired") + "\n").build();
    }

challenge() [1/2]

static ConsoleDisplayMode org.keycloak.authentication.ConsoleDisplayMode.challenge ( RequiredActionContext  context )

inlinestatic

Build challenge response for required actions

引数

context

戻り値

                                                                              {
        return new ConsoleDisplayMode(context);

    }

challenge() [2/2]

static ConsoleDisplayMode org.keycloak.authentication.ConsoleDisplayMode.challenge ( AuthenticationFlowContext  context )

inlinestatic

Build challenge response for authentication flows

引数

context

戻り値

                                                                                  {
        return new ConsoleDisplayMode(context);

    }

form()

LoginFormsProvider org.keycloak.authentication.ConsoleDisplayMode.form ( )

inline

Create a theme form pre-populated with challenge

戻り値

                                     {
        if (header == null) throw new RuntimeException("Header Not Set");
        return formInternal()
                .setStatus(Response.Status.UNAUTHORIZED)
                .setMediaType(MediaType.TEXT_PLAIN_TYPE)
                .setResponseHeader(HttpHeaders.WWW_AUTHENTICATE, header.build());
    }

formInternal()

LoginFormsProvider org.keycloak.authentication.ConsoleDisplayMode.formInternal ( )

inlineprotected

                                                {
        if (requiredActionContext != null) {
            return requiredActionContext.form();
        } else {
            return flowContext.form();

        }
    }

header() [1/3]

static HeaderBuilder org.keycloak.authentication.ConsoleDisplayMode.header ( RequiredActionContext  context )

inlinestatic

Build challenge response header only for required actions

引数

context

戻り値

                                                                      {
        return new ConsoleDisplayMode(context).header();

    }

header() [2/3]

static HeaderBuilder org.keycloak.authentication.ConsoleDisplayMode.header ( AuthenticationFlowContext  context )

inlinestatic

Build challenge response header only for authentication flows

引数

context

戻り値

                                                                          {
        return new ConsoleDisplayMode(context).header();

    }

header() [3/3]

HeaderBuilder org.keycloak.authentication.ConsoleDisplayMode.header ( )

inline

Start building the header

戻り値

                                  {
        String callback;
        if (requiredActionContext != null) {
            callback = requiredActionContext.getActionUrl(true).toString();
        } else {
            callback = flowContext.getActionUrl(flowContext.generateAccessCode(), true).toString();

        }
        header = new HeaderBuilder(callback);
        return header;
    }

message()

Response org.keycloak.authentication.ConsoleDisplayMode.message ( String  msg, String...  params  )

inline

Create challenge response with a body generated from localized message.properties of your theme

引数

msg	message id
params	parameters to use to format the message

戻り値

                                                          {
        if (header == null) throw new RuntimeException("Header Not Set");
        Response response = Response.status(401)
                .header(HttpHeaders.WWW_AUTHENTICATE, header.build())
                .type(MediaType.TEXT_PLAIN)
                .entity("\n" + formInternal().getMessage(msg, params) + "\n").build();
        return response;
    }

response()

Response org.keycloak.authentication.ConsoleDisplayMode.response ( )

inline

Generate response with empty http response body

戻り値

                               {
        if (header == null) throw new RuntimeException("Header Not Set");
        Response response = Response.status(401)
                .header(HttpHeaders.WWW_AUTHENTICATE, header.build()).build();
        return response;

    }

text()

Response org.keycloak.authentication.ConsoleDisplayMode.text ( String  text )

inline

Create challenge response with a text message body

引数

text	plain text of http response body

戻り値

                                      {
        if (header == null) throw new RuntimeException("Header Not Set");
        Response response = Response.status(401)
                .header(HttpHeaders.WWW_AUTHENTICATE, header.build())
                .type(MediaType.TEXT_PLAIN)
                .entity("\n" + text + "\n").build();
        return response;

    }

メンバ詳解

flowContext

AuthenticationFlowContext org.keycloak.authentication.ConsoleDisplayMode.flowContext

protected

header

HeaderBuilder org.keycloak.authentication.ConsoleDisplayMode.header

protected

requiredActionContext

RequiredActionContext org.keycloak.authentication.ConsoleDisplayMode.requiredActionContext

protected

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/ConsoleDisplayMode.java