jdk/src/share/classes/org/ietf/jgss/package.html
author ohair
Wed, 26 May 2010 20:28:04 -0700
changeset 5551 327690766109
parent 5506 202f599c92aa
child 21278 ef8a3a2a72f2
permissions -rw-r--r--
6956202: Fix a few missed rebranding issues, please contact lines etc. Reviewed-by: jjg, darcy, weijun
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
<html>
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
<head>
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
<!--
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     5
Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    10
published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    12
by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
5551
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents: 5506
diff changeset
    24
Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents: 5506
diff changeset
    25
or visit www.oracle.com if you need additional information or have any
327690766109 6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents: 5506
diff changeset
    26
questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
-->
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
</head>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
<body bgcolor="white">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
    This package presents a framework that allows application developers to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
    make use of security services like authentication, data integrity and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
    data confidentiality from a variety of underlying security mechanisms
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
    like Kerberos, using a unified API. The security mechanisms that an
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
    application can
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
    chose to use are identified with unique object identifiers. One example 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
    of such a mechanism is the Kerberos v5 GSS-API mechanism (object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
    identifier 1.2.840.113554.1.2.2). This mechanism is available through
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    the default instance of the GSSManager class.<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    The GSS-API is defined in a language independent way in 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
    <a href=http://www.ietf.org/rfc/rfc2743.txt>RFC 2743</a>. The Java
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
    language bindings are defined in 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
    <a href=http://www.ietf.org/rfc/rfc2853.txt>RFC 2853</a><p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
    An application starts out by instantiating a <code>GSSManager</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    which then serves as a factory for a security context. An application
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
    can use specific principal names and credentials that are also created
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    using the GSSManager; or it can instantiate a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    context with system defaults. It then goes through a context
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    establishment loop. Once a context is established with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    peer, authentication is complete. Data protection such as integrity
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    and confidentiality can then be obtained from this context.<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    The GSS-API does not perform any communication with the peer. It merely 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    produces tokens that the application must somehow transport to the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    other end.<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
<h3>Credential Acquisition</h3>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
<a name=useSubjectCredsOnly>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    The GSS-API itself does not dictate how an underlying mechanism
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    obtains the credentials that are needed for authentication. It is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
    assumed that prior to calling the GSS-API, these credentials are
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    obtained and stored in a location that the mechanism provider is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    aware of. However, the default model in the Java platform will be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    that mechanism providers must obtain credentials only from the private
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    or public credential sets associated with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    {@link javax.security.auth.Subject Subject} in the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    current access control context.  The Kerberos v5  
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    mechanism will search for the required INITIATE and ACCEPT credentials 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    ({@link javax.security.auth.kerberos.KerberosTicket KerberosTicket} and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     {@link javax.security.auth.kerberos.KerberosKey KerberosKey}) in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    the private credential set where as some other mechanism might look
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    in the public set or in both.  If the desired credential is not
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    present in the appropriate sets of the current Subject, the GSS-API
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
    call must fail.<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    This model has the advantage that credential management
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    is simple and predictable from the applications point of view.  An
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    application, given the right permissions, can purge the credentials in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    the Subject or renew them using standard Java API's.  If it purged
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    the credentials, it would be sure that the JGSS mechanism would fail,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    or if it renewed a time based credential it would be sure that a JGSS
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    mechanism would succeed.<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
    This model does require that a {@link
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    javax.security.auth.login JAAS login} be performed in order to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
    authenticate and populate a Subject that the JGSS mechnanism can later 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    utilize. However, applications have the ability to relax this
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
    restiction by means of a system property:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    <code>javax.security.auth.useSubjectCredsOnly</code>. By default
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
    this system property will be assumed to be <code>true</code> (even when
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
    it is unset) indicating that providers must only use the credentials
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
    that are present in the current Subject. However, if this property is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
    explicitly set to false by the application, then it indicates that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
    the provider is free to use any credentials cache of its choice. Such
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
    a credential cache might be a disk cache, an in-memory cache, or even
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
    just the current Subject itself.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
<h2>Related Documentation</h2>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
For an online tutorial on using Java GSS-API, please see
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
<a href="../../../../technotes/guides/security/jgss/tutorials/index.html">Introduction to JAAS and Java GSS-API</a>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
</p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
<!--
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
<h2>Package Specification</h2>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
<ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
  <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
</ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
<h2>Related Documentation</h2>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
For overviews, tutorials, examples, guides, and tool documentation, please see:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
<ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
  <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
</ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
-->
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
@since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
</body>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
</html>