org.keycloak.common.util.ServerCookie クラス

org.keycloak.common.util.ServerCookie の継承関係図

org.keycloak.common.util.ServerCookie 連携図

静的公開メンバ関数
static boolean	isToken (String value)
static boolean	containsCTL (String value, int version)
static boolean	isToken2 (String value)
static boolean	checkName (String name)
static String	getCookieHeaderName (int version)
static String	formatOldCookie (Date d)
static void	formatOldCookie (Date d, StringBuffer sb, FieldPosition fp)
static void	appendCookieValue (StringBuffer headerBuf, int version, String name, String value, String path, String domain, String comment, int maxAge, boolean isSecure, boolean httpOnly)
static void	maybeQuote (int version, StringBuffer buf, String value)
static boolean	alreadyQuoted (String value)
static void	maybeQuote2 (int version, StringBuffer buf, String value)

静的公開変数類
static final TimeZone	GMT_ZONE = TimeZone.getTimeZone("GMT")

静的変数
	static

静的非公開メンバ関数
static String	escapeDoubleQuotes (String s, int beginIndex, int endIndex)

静的非公開変数類
static final String	tspecials = ",; "
static final String	tspecials2 = "()<>@,;:\\\"/[]?={} \t"
static final Locale	LOCALE_US = Locale.US
static final String	OLD_COOKIE_PATTERN = "EEE, dd-MMM-yyyy HH:mm:ss z"
static final DateFormat	OLD_COOKIE_FORMAT = new SimpleDateFormat(OLD_COOKIE_PATTERN, LOCALE_US)
static final String	ancientDate = formatOldCookie(new Date(10000))

詳解

Server-side cookie representation. borrowed from Tomcat.

関数詳解

alreadyQuoted()

static boolean org.keycloak.common.util.ServerCookie.alreadyQuoted ( String  value )

inlinestatic

                                                      {
        if (value == null || value.length() == 0) return false;
        return (value.charAt(0) == '\"' && value.charAt(value.length() - 1) == '\"');
    }

appendCookieValue()

static void org.keycloak.common.util.ServerCookie.appendCookieValue ( StringBuffer  headerBuf, int  version, String  name, String  value, String  path, String  domain, String  comment, int  maxAge, boolean  isSecure, boolean  httpOnly  )

inlinestatic

                                                           {
        StringBuffer buf = new StringBuffer();
        // Servlet implementation checks name
        buf.append(name);
        buf.append("=");
        // Servlet implementation does not check anything else

        // NOTE!!! BROWSERS REALLY DON'T LIKE QUOTING
        //maybeQuote2(version, buf, value);
        buf.append(value);

        // Add version 1 specific information
        if (version == 1) {
            // Version=1 ... required
            buf.append("; Version=1");

            // Comment=comment
            if (comment != null) {
                buf.append("; Comment=");
                //maybeQuote2(version, buf, comment);
                buf.append(comment);
            }
        }

        // Add domain information, if present
        if (domain != null) {
            buf.append("; Domain=");
            //maybeQuote2(version, buf, domain);
            buf.append(domain);
        }

        // Max-Age=secs ... or use old "Expires" format
        // TODO RFC2965 Discard
        if (maxAge >= 0) {
            // Wdy, DD-Mon-YY HH:MM:SS GMT ( Expires Netscape format )
            buf.append("; Expires=");
            // To expire immediately we need to set the time in past
            if (maxAge == 0)
                buf.append(ancientDate);
            else
                formatOldCookie
                        (new Date(System.currentTimeMillis() +
                                        maxAge * 1000L), buf,
                                new FieldPosition(0));

            buf.append("; Max-Age=");
            buf.append(maxAge);
        }

        // Path=path
        if (path != null) {
            buf.append("; Path=");
            buf.append(path);
        }

        // Secure
        if (isSecure) {
            buf.append("; Secure");
        }

        // HttpOnly
        if (httpOnly) {
            buf.append("; HttpOnly");
        }

        headerBuf.append(buf);
    }

checkName()

static boolean org.keycloak.common.util.ServerCookie.checkName ( String  name )

inlinestatic

非推奨:

• Not used

                                                 {
        if (!isToken(name)
                || name.equalsIgnoreCase("Comment")     // rfc2019
                || name.equalsIgnoreCase("Discard")     // rfc2965
                || name.equalsIgnoreCase("Domain")      // rfc2019
                || name.equalsIgnoreCase("Expires")     // Netscape
                || name.equalsIgnoreCase("Max-Age")     // rfc2019
                || name.equalsIgnoreCase("Path")        // rfc2019
                || name.equalsIgnoreCase("Secure")      // rfc2019
                || name.equalsIgnoreCase("Version")     // rfc2019
            // TODO remaining RFC2965 attributes
                ) {
            return false;
        }
        return true;
    }

containsCTL()

static boolean org.keycloak.common.util.ServerCookie.containsCTL ( String  value, int  version  )

inlinestatic

                                                                 {
        if (value == null) return false;
        int len = value.length();
        for (int i = 0; i < len; i++) {
            char c = value.charAt(i);
            if (c < 0x20 || c >= 0x7f) {
                if (c == 0x09)
                    continue; //allow horizontal tabs
                return true;
            }
        }
        return false;
    }

escapeDoubleQuotes()

static String org.keycloak.common.util.ServerCookie.escapeDoubleQuotes ( String  s, int  beginIndex, int  endIndex  )

inlinestaticprivate

Escapes any double quotes in the given string.

引数

s	the input string
beginIndex	start index inclusive
endIndex	exclusive

戻り値

The (possibly) escaped string

                                                                                     {

        if (s == null || s.length() == 0 || s.indexOf('"') == -1) {
            return s;
        }

        StringBuffer b = new StringBuffer();
        for (int i = beginIndex; i < endIndex; i++) {
            char c = s.charAt(i);
            if (c == '\\') {
                b.append(c);
                //ignore the character after an escape, just append it
                if (++i >= endIndex) throw new IllegalArgumentException("Invalid escape character in cookie value.");
                b.append(s.charAt(i));
            } else if (c == '"')
                b.append('\\').append('"');
            else
                b.append(c);
        }

        return b.toString();
    }

formatOldCookie() [1/2]

static String org.keycloak.common.util.ServerCookie.formatOldCookie ( Date  d )

inlinestatic

                                                 {
        String ocf = null;
        synchronized (OLD_COOKIE_FORMAT) {
            ocf = OLD_COOKIE_FORMAT.format(d);
        }
        return ocf;
    }

formatOldCookie() [2/2]

static void org.keycloak.common.util.ServerCookie.formatOldCookie ( Date  d, StringBuffer  sb, FieldPosition  fp  )

inlinestatic

                                                         {
        synchronized (OLD_COOKIE_FORMAT) {
            OLD_COOKIE_FORMAT.format(d, sb, fp);
        }
    }

getCookieHeaderName()

static String org.keycloak.common.util.ServerCookie.getCookieHeaderName ( int  version )

inlinestatic

Return the header name to set the cookie, based on cookie version.

                                                          {
        // TODO Re-enable logging when RFC2965 is implemented
        // log( (version==1) ? "Set-Cookie2" : "Set-Cookie");
        if (version == 1) {
            // XXX RFC2965 not referenced in Servlet Spec
            // Set-Cookie2 is not supported by Netscape 4, 6, IE 3, 5
            // Set-Cookie2 is supported by Lynx and Opera
            // Need to check on later IE and FF releases but for now...
            // RFC2109
            return "Set-Cookie";
            // return "Set-Cookie2";
        } else {
            // Old Netscape
            return "Set-Cookie";
        }
    }

isToken()

static boolean org.keycloak.common.util.ServerCookie.isToken ( String  value )

inlinestatic

                                                {
        if (value == null) return true;
        int len = value.length();

        for (int i = 0; i < len; i++) {
            char c = value.charAt(i);

            if (tspecials.indexOf(c) != -1)
                return false;
        }
        return true;
    }

isToken2()

static boolean org.keycloak.common.util.ServerCookie.isToken2 ( String  value )

inlinestatic

                                                 {
        if (value == null) return true;
        int len = value.length();

        for (int i = 0; i < len; i++) {
            char c = value.charAt(i);
            if (tspecials2.indexOf(c) != -1)
                return false;
        }
        return true;
    }

maybeQuote()

static void org.keycloak.common.util.ServerCookie.maybeQuote ( int  version, StringBuffer  buf, String  value  )

inlinestatic

非推奨:

• Not used

                                                                               {
        // special case - a \n or \r  shouldn't happen in any case
        if (isToken(value)) {
            buf.append(value);
        } else {
            buf.append('"');
            buf.append(escapeDoubleQuotes(value, 0, value.length()));
            buf.append('"');
        }
    }

maybeQuote2()

static void org.keycloak.common.util.ServerCookie.maybeQuote2 ( int  version, StringBuffer  buf, String  value  )

inlinestatic

Quotes values using rules that vary depending on Cookie version.

引数

version
buf
value

                                                                                {
        if (value == null || value.length() == 0) {
            buf.append("\"\"");
        } else if (containsCTL(value, version))
            throw new IllegalArgumentException("Control character in cookie value, consider BASE64 encoding your value");
        else if (alreadyQuoted(value)) {
            buf.append('"');
            buf.append(escapeDoubleQuotes(value, 1, value.length() - 1));
            buf.append('"');
        } else if (version == 0 && !isToken(value)) {
            buf.append('"');
            buf.append(escapeDoubleQuotes(value, 0, value.length()));
            buf.append('"');
        } else if (version == 1 && !isToken2(value)) {
            buf.append('"');
            buf.append(escapeDoubleQuotes(value, 0, value.length()));
            buf.append('"');
        } else {
            buf.append(value);
        }
    }

メンバ詳解

ancientDate

final String org.keycloak.common.util.ServerCookie.ancientDate = formatOldCookie(new Date(10000))

staticprivate

GMT_ZONE

final TimeZone org.keycloak.common.util.ServerCookie.GMT_ZONE = TimeZone.getTimeZone("GMT")

static

GMT timezone - all HTTP dates are on GMT

LOCALE_US

final Locale org.keycloak.common.util.ServerCookie.LOCALE_US = Locale.US

staticprivate

US locale - all HTTP dates are in english

OLD_COOKIE_FORMAT

final DateFormat org.keycloak.common.util.ServerCookie.OLD_COOKIE_FORMAT = new SimpleDateFormat(OLD_COOKIE_PATTERN, LOCALE_US)

staticprivate

OLD_COOKIE_PATTERN

final String org.keycloak.common.util.ServerCookie.OLD_COOKIE_PATTERN = "EEE, dd-MMM-yyyy HH:mm:ss z"

staticprivate

Pattern used for old cookies

static

org.keycloak.common.util.ServerCookie.static

staticpackage

初期値:

{
        OLD_COOKIE_FORMAT.setTimeZone(GMT_ZONE)

tspecials

final String org.keycloak.common.util.ServerCookie.tspecials = ",; "

staticprivate

tspecials2

final String org.keycloak.common.util.ServerCookie.tspecials2 = "()<>@,;:\\\"/[]?={} \t"

staticprivate

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/common/util/ServerCookie.java