jdk/src/share/classes/javax/security/auth/kerberos/package-info.java
author weijun
Fri, 04 Apr 2014 21:19:43 +0800
changeset 23716 33cc4db6209b
parent 18830 90956ead732f
child 24865 09b1d992ca72
permissions -rw-r--r--
8029995: accept yes/no for boolean krb5.conf settings Reviewed-by: mullan
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
18830
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     1
/*
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     2
 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     4
 *
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    10
 *
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    15
 * accompanied this code).
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    16
 *
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    20
 *
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    23
 * questions.
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    24
 */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
18830
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    26
/**
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    27
 * This package contains utility classes related to the Kerberos network
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    28
 * authentication protocol. They do not provide much Kerberos support
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    29
 * themselves.<p>
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    30
 *
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    31
 * The Kerberos network authentication protocol is defined in
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    32
 * <a href=http://www.ietf.org/rfc/rfc4120.txt>RFC 4120</a>. The Java
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    33
 * platform contains support for the client side of Kerberos via the
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    34
 * {@link org.ietf.jgss} package. There might also be
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    35
 * a login module that implements
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    36
 * {@link javax.security.auth.spi.LoginModule LoginModule} to authenticate
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    37
 * Kerberos principals.<p>
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    38
 *
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    39
 * You can provide the name of your default realm and Key Distribution
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    40
 * Center (KDC) host for that realm using the system properties
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    41
 * {@code java.security.krb5.realm} and {@code java.security.krb5.kdc}.
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    42
 * Both properties must be set.
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    43
 * Alternatively, the {@code java.security.krb5.conf} system property can
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    44
 * be set to the location of an MIT style {@code krb5.conf} configuration
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    45
 * file. If none of these system properties are set, the {@code krb5.conf}
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    46
 * file is searched for in an implementation-specific manner. Typically,
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    47
 * an implementation will first look for a {@code krb5.conf} file in
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    48
 * {@code <java-home>/lib/security} and failing that, in an OS-specific
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    49
 * location.<p>
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    50
 *
23716
33cc4db6209b 8029995: accept yes/no for boolean krb5.conf settings
weijun
parents: 18830
diff changeset
    51
 * The {@code krb5.conf} file is formatted in the Windows INI file style,
33cc4db6209b 8029995: accept yes/no for boolean krb5.conf settings
weijun
parents: 18830
diff changeset
    52
 * which contains a series of relations grouped into different sections.
33cc4db6209b 8029995: accept yes/no for boolean krb5.conf settings
weijun
parents: 18830
diff changeset
    53
 * Each relation contains a key and a value, the value can be an arbitrary
33cc4db6209b 8029995: accept yes/no for boolean krb5.conf settings
weijun
parents: 18830
diff changeset
    54
 * string or a boolean value. A boolean value can be one of "true", "false",
33cc4db6209b 8029995: accept yes/no for boolean krb5.conf settings
weijun
parents: 18830
diff changeset
    55
 * "yes", or "no", case-insensitive.<p>
33cc4db6209b 8029995: accept yes/no for boolean krb5.conf settings
weijun
parents: 18830
diff changeset
    56
 *
18830
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    57
 * @since JDK1.4
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    58
 */
90956ead732f 8020557: javadoc cleanup in javax.security
juh
parents: 14898
diff changeset
    59
package javax.security.auth.kerberos;