draft-ietf-kitten-rfc5653bis-06.txt   draft-ietf-kitten-rfc5653bis-07.txt 
Network Working Group M. Upadhyay Network Working Group M. Upadhyay
Internet-Draft Google Internet-Draft Google
Obsoletes: 5653 (if approved) S. Malkani Obsoletes: 5653 (if approved) S. Malkani
Intended status: Standards Track ActivIdentity Intended status: Standards Track ActivIdentity
Expires: May 16, 2018 W. Wang Expires: August 13, 2018 W. Wang
Oracle Oracle
November 12, 2017 February 9, 2018
Generic Security Service API Version 2: Java Bindings Update Generic Security Service API Version 2: Java Bindings Update
draft-ietf-kitten-rfc5653bis-06 draft-ietf-kitten-rfc5653bis-07
Abstract Abstract
The Generic Security Services Application Program Interface (GSS-API) The Generic Security Services Application Program Interface (GSS-API)
offers application programmers uniform access to security services offers application programmers uniform access to security services
atop a variety of underlying cryptographic mechanisms. This document atop a variety of underlying cryptographic mechanisms. This document
updates the Java bindings for the GSS-API that are specified in updates the Java bindings for the GSS-API that are specified in
"Generic Security Service API Version 2 : Java Bindings Update" (RFC "Generic Security Service API Version 2 : Java Bindings Update" (RFC
5653). This document obsoletes RFC 5653 by adding a new output token 5653). This document obsoletes RFC 5653 by adding a new output token
field to the GSSException class so that when the initSecContext or field to the GSSException class so that when the initSecContext or
skipping to change at page 2, line 7 skipping to change at page 2, line 7
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 16, 2018. This Internet-Draft will expire on August 13, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 2, line 39 skipping to change at page 2, line 39
Without obtaining an adequate license from the person(s) controlling Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other it for publication as an RFC or to translate it into languages other
than English. than English.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 6 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 6
2. GSS-API Operational Paradigm . . . . . . . . . . . . . . . . 7 2. Notational Conventions . . . . . . . . . . . . . . . . . . . 7
3. Additional Controls . . . . . . . . . . . . . . . . . . . . . 8 3. GSS-API Operational Paradigm . . . . . . . . . . . . . . . . 7
3.1. Delegation . . . . . . . . . . . . . . . . . . . . . . . 9 4. Additional Controls . . . . . . . . . . . . . . . . . . . . . 8
3.2. Mutual Authentication . . . . . . . . . . . . . . . . . . 10 4.1. Delegation . . . . . . . . . . . . . . . . . . . . . . . 10
3.3. Replay and Out-of-Sequence Detection . . . . . . . . . . 11 4.2. Mutual Authentication . . . . . . . . . . . . . . . . . . 10
3.4. Anonymous Authentication . . . . . . . . . . . . . . . . 11 4.3. Replay and Out-of-Sequence Detection . . . . . . . . . . 11
3.5. Integrity and Confidentiality . . . . . . . . . . . . . . 12 4.4. Anonymous Authentication . . . . . . . . . . . . . . . . 12
3.6. Inter-process Context Transfer . . . . . . . . . . . . . 13 4.5. Integrity and Confidentiality . . . . . . . . . . . . . . 13
3.7. The Use of Incomplete Contexts . . . . . . . . . . . . . 13 4.6. Inter-process Context Transfer . . . . . . . . . . . . . 13
4. Calling Conventions . . . . . . . . . . . . . . . . . . . . . 14 4.7. The Use of Incomplete Contexts . . . . . . . . . . . . . 14
4.1. Package Name . . . . . . . . . . . . . . . . . . . . . . 14 5. Calling Conventions . . . . . . . . . . . . . . . . . . . . . 14
4.2. Provider Framework . . . . . . . . . . . . . . . . . . . 14 5.1. Package Name . . . . . . . . . . . . . . . . . . . . . . 14
4.3. Integer Types . . . . . . . . . . . . . . . . . . . . . . 15 5.2. Provider Framework . . . . . . . . . . . . . . . . . . . 14
4.4. Opaque Data Types . . . . . . . . . . . . . . . . . . . . 15 5.3. Integer Types . . . . . . . . . . . . . . . . . . . . . . 15
4.5. Strings . . . . . . . . . . . . . . . . . . . . . . . . . 15 5.4. Opaque Data Types . . . . . . . . . . . . . . . . . . . . 15
4.6. Object Identifiers . . . . . . . . . . . . . . . . . . . 16 5.5. Strings . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.7. Object Identifier Sets . . . . . . . . . . . . . . . . . 16 5.6. Object Identifiers . . . . . . . . . . . . . . . . . . . 16
4.8. Credentials . . . . . . . . . . . . . . . . . . . . . . . 16 5.7. Object Identifier Sets . . . . . . . . . . . . . . . . . 16
4.9. Contexts . . . . . . . . . . . . . . . . . . . . . . . . 18 5.8. Credentials . . . . . . . . . . . . . . . . . . . . . . . 17
4.10. Authentication Tokens . . . . . . . . . . . . . . . . . . 19 5.9. Contexts . . . . . . . . . . . . . . . . . . . . . . . . 18
4.11. Inter-Process Tokens . . . . . . . . . . . . . . . . . . 19 5.10. Authentication Tokens . . . . . . . . . . . . . . . . . . 19
4.12. Error Reporting . . . . . . . . . . . . . . . . . . . . . 19 5.11. Inter-Process Tokens . . . . . . . . . . . . . . . . . . 19
4.12.1. GSS Status Codes . . . . . . . . . . . . . . . . . . 20 5.12. Error Reporting . . . . . . . . . . . . . . . . . . . . . 20
4.12.2. Mechanism-Specific Status Codes . . . . . . . . . . 22 5.12.1. GSS Status Codes . . . . . . . . . . . . . . . . . . 20
4.12.3. Supplementary Status Codes . . . . . . . . . . . . . 22 5.12.2. Mechanism-Specific Status Codes . . . . . . . . . . 22
4.13. Names . . . . . . . . . . . . . . . . . . . . . . . . . . 23 5.12.3. Supplementary Status Codes . . . . . . . . . . . . . 23
4.14. Channel Bindings . . . . . . . . . . . . . . . . . . . . 26 5.13. Names . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.15. Optional Parameters . . . . . . . . . . . . . . . . . . . 27 5.14. Channel Bindings . . . . . . . . . . . . . . . . . . . . 26
5. Introduction to GSS-API Classes and Interfaces . . . . . . . 27 5.15. Optional Parameters . . . . . . . . . . . . . . . . . . . 27
5.1. GSSManager Class . . . . . . . . . . . . . . . . . . . . 27 6. Introduction to GSS-API Classes and Interfaces . . . . . . . 27
5.2. GSSName Interface . . . . . . . . . . . . . . . . . . . . 28 6.1. GSSManager Class . . . . . . . . . . . . . . . . . . . . 27
5.3. GSSCredential Interface . . . . . . . . . . . . . . . . . 29 6.2. GSSName Interface . . . . . . . . . . . . . . . . . . . . 28
5.4. GSSContext Interface . . . . . . . . . . . . . . . . . . 30 6.3. GSSCredential Interface . . . . . . . . . . . . . . . . . 29
5.5. MessageProp Class . . . . . . . . . . . . . . . . . . . . 32 6.4. GSSContext Interface . . . . . . . . . . . . . . . . . . 30
5.6. GSSException Class . . . . . . . . . . . . . . . . . . . 32 6.5. MessageProp Class . . . . . . . . . . . . . . . . . . . . 32
5.7. Oid Class . . . . . . . . . . . . . . . . . . . . . . . . 32 6.6. GSSException Class . . . . . . . . . . . . . . . . . . . 32
5.8. ChannelBinding Class . . . . . . . . . . . . . . . . . . 32 6.7. Oid Class . . . . . . . . . . . . . . . . . . . . . . . . 32
6. Detailed GSS-API Class Description . . . . . . . . . . . . . 33 6.8. ChannelBinding Class . . . . . . . . . . . . . . . . . . 32
6.1. public abstract class GSSManager . . . . . . . . . . . . 33 7. Detailed GSS-API Class Description . . . . . . . . . . . . . 33
6.1.1. getInstance . . . . . . . . . . . . . . . . . . . . . 34 7.1. public abstract class GSSManager . . . . . . . . . . . . 33
6.1.2. getMechs . . . . . . . . . . . . . . . . . . . . . . 34 7.1.1. getInstance . . . . . . . . . . . . . . . . . . . . . 34
6.1.3. getNamesForMech . . . . . . . . . . . . . . . . . . . 34 7.1.2. getMechs . . . . . . . . . . . . . . . . . . . . . . 34
6.1.4. getMechsForName . . . . . . . . . . . . . . . . . . . 35 7.1.3. getNamesForMech . . . . . . . . . . . . . . . . . . . 34
6.1.5. createName . . . . . . . . . . . . . . . . . . . . . 35 7.1.4. getMechsForName . . . . . . . . . . . . . . . . . . . 35
6.1.6. createName . . . . . . . . . . . . . . . . . . . . . 35 7.1.5. createName . . . . . . . . . . . . . . . . . . . . . 35
6.1.7. createName . . . . . . . . . . . . . . . . . . . . . 36 7.1.6. createName . . . . . . . . . . . . . . . . . . . . . 35
6.1.8. createName . . . . . . . . . . . . . . . . . . . . . 37 7.1.7. createName . . . . . . . . . . . . . . . . . . . . . 36
6.1.9. createCredential . . . . . . . . . . . . . . . . . . 37 7.1.8. createName . . . . . . . . . . . . . . . . . . . . . 37
6.1.10. createCredential . . . . . . . . . . . . . . . . . . 38 7.1.9. createCredential . . . . . . . . . . . . . . . . . . 37
6.1.11. createCredential . . . . . . . . . . . . . . . . . . 38 7.1.10. createCredential . . . . . . . . . . . . . . . . . . 38
6.1.12. createContext . . . . . . . . . . . . . . . . . . . . 39 7.1.11. createCredential . . . . . . . . . . . . . . . . . . 38
6.1.13. createContext . . . . . . . . . . . . . . . . . . . . 40 7.1.12. createContext . . . . . . . . . . . . . . . . . . . . 39
6.1.14. createContext . . . . . . . . . . . . . . . . . . . . 40 7.1.13. createContext . . . . . . . . . . . . . . . . . . . . 40
6.1.15. addProviderAtFront . . . . . . . . . . . . . . . . . 40 7.1.14. createContext . . . . . . . . . . . . . . . . . . . . 40
6.1.15.1. addProviderAtFront Example Code . . . . . . . . 41 7.1.15. addProviderAtFront . . . . . . . . . . . . . . . . . 40
6.1.16. addProviderAtEnd . . . . . . . . . . . . . . . . . . 42 7.1.15.1. addProviderAtFront Example Code . . . . . . . . 41
6.1.16.1. addProviderAtEnd Example Code . . . . . . . . . 43 7.1.16. addProviderAtEnd . . . . . . . . . . . . . . . . . . 42
6.1.17. Example Code . . . . . . . . . . . . . . . . . . . . 44 7.1.16.1. addProviderAtEnd Example Code . . . . . . . . . 43
6.2. public interface GSSName . . . . . . . . . . . . . . . . 44 7.1.17. Example Code . . . . . . . . . . . . . . . . . . . . 44
6.2.1. Static Constants . . . . . . . . . . . . . . . . . . 44 7.2. public interface GSSName . . . . . . . . . . . . . . . . 44
6.2.2. equals . . . . . . . . . . . . . . . . . . . . . . . 45 7.2.1. Static Constants . . . . . . . . . . . . . . . . . . 44
6.2.3. equals . . . . . . . . . . . . . . . . . . . . . . . 45 7.2.2. equals . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.4. canonicalize . . . . . . . . . . . . . . . . . . . . 46 7.2.3. equals . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.5. export . . . . . . . . . . . . . . . . . . . . . . . 46 7.2.4. canonicalize . . . . . . . . . . . . . . . . . . . . 46
6.2.6. toString . . . . . . . . . . . . . . . . . . . . . . 46 7.2.5. export . . . . . . . . . . . . . . . . . . . . . . . 46
6.2.7. getStringNameType . . . . . . . . . . . . . . . . . . 47 7.2.6. toString . . . . . . . . . . . . . . . . . . . . . . 46
6.2.8. isAnonymous . . . . . . . . . . . . . . . . . . . . . 47 7.2.7. getStringNameType . . . . . . . . . . . . . . . . . . 47
6.2.9. isMN . . . . . . . . . . . . . . . . . . . . . . . . 47 7.2.8. isAnonymous . . . . . . . . . . . . . . . . . . . . . 47
6.2.10. Example Code . . . . . . . . . . . . . . . . . . . . 47 7.2.9. isMN . . . . . . . . . . . . . . . . . . . . . . . . 47
6.3. public interface GSSCredential implements Cloneable . . . 48 7.2.10. Example Code . . . . . . . . . . . . . . . . . . . . 47
6.3.1. Static Constants . . . . . . . . . . . . . . . . . . 49 7.3. public interface GSSCredential implements Cloneable . . . 48
6.3.2. dispose . . . . . . . . . . . . . . . . . . . . . . . 50 7.3.1. Static Constants . . . . . . . . . . . . . . . . . . 49
6.3.3. getName . . . . . . . . . . . . . . . . . . . . . . . 50 7.3.2. dispose . . . . . . . . . . . . . . . . . . . . . . . 50
6.3.4. getName . . . . . . . . . . . . . . . . . . . . . . . 50 7.3.3. getName . . . . . . . . . . . . . . . . . . . . . . . 50
6.3.5. getRemainingLifetime . . . . . . . . . . . . . . . . 50 7.3.4. getName . . . . . . . . . . . . . . . . . . . . . . . 50
6.3.6. getRemainingInitLifetime . . . . . . . . . . . . . . 51 7.3.5. getRemainingLifetime . . . . . . . . . . . . . . . . 50
6.3.7. getRemainingAcceptLifetime . . . . . . . . . . . . . 51 7.3.6. getRemainingInitLifetime . . . . . . . . . . . . . . 51
6.3.8. getUsage . . . . . . . . . . . . . . . . . . . . . . 51 7.3.7. getRemainingAcceptLifetime . . . . . . . . . . . . . 51
6.3.9. getUsage . . . . . . . . . . . . . . . . . . . . . . 52 7.3.8. getUsage . . . . . . . . . . . . . . . . . . . . . . 51
6.3.10. getMechs . . . . . . . . . . . . . . . . . . . . . . 52 7.3.9. getUsage . . . . . . . . . . . . . . . . . . . . . . 52
6.3.11. add . . . . . . . . . . . . . . . . . . . . . . . . . 52 7.3.10. getMechs . . . . . . . . . . . . . . . . . . . . . . 52
6.3.12. equals . . . . . . . . . . . . . . . . . . . . . . . 53 7.3.11. add . . . . . . . . . . . . . . . . . . . . . . . . . 52
6.3.13. Example Code . . . . . . . . . . . . . . . . . . . . 53 7.3.12. equals . . . . . . . . . . . . . . . . . . . . . . . 53
6.4. public interface GSSContext . . . . . . . . . . . . . . . 54 7.3.13. Example Code . . . . . . . . . . . . . . . . . . . . 53
6.4.1. Static Constants . . . . . . . . . . . . . . . . . . 55 7.4. public interface GSSContext . . . . . . . . . . . . . . . 54
6.4.2. initSecContext . . . . . . . . . . . . . . . . . . . 55 7.4.1. Static Constants . . . . . . . . . . . . . . . . . . 55
6.4.3. acceptSecContext . . . . . . . . . . . . . . . . . . 56 7.4.2. initSecContext . . . . . . . . . . . . . . . . . . . 55
6.4.4. isEstablished . . . . . . . . . . . . . . . . . . . . 57 7.4.3. acceptSecContext . . . . . . . . . . . . . . . . . . 56
6.4.5. dispose . . . . . . . . . . . . . . . . . . . . . . . 57 7.4.4. isEstablished . . . . . . . . . . . . . . . . . . . . 57
6.4.6. getWrapSizeLimit . . . . . . . . . . . . . . . . . . 57 7.4.5. dispose . . . . . . . . . . . . . . . . . . . . . . . 57
6.4.7. wrap . . . . . . . . . . . . . . . . . . . . . . . . 58 7.4.6. getWrapSizeLimit . . . . . . . . . . . . . . . . . . 57
6.4.8. unwrap . . . . . . . . . . . . . . . . . . . . . . . 59 7.4.7. wrap . . . . . . . . . . . . . . . . . . . . . . . . 58
6.4.9. getMIC . . . . . . . . . . . . . . . . . . . . . . . 60 7.4.8. unwrap . . . . . . . . . . . . . . . . . . . . . . . 59
6.4.10. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 60 7.4.9. getMIC . . . . . . . . . . . . . . . . . . . . . . . 60
6.4.11. export . . . . . . . . . . . . . . . . . . . . . . . 61 7.4.10. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 60
6.4.12. requestMutualAuth . . . . . . . . . . . . . . . . . . 62 7.4.11. export . . . . . . . . . . . . . . . . . . . . . . . 61
6.4.13. requestReplayDet . . . . . . . . . . . . . . . . . . 62 7.4.12. requestMutualAuth . . . . . . . . . . . . . . . . . . 62
6.4.14. requestSequenceDet . . . . . . . . . . . . . . . . . 62 7.4.13. requestReplayDet . . . . . . . . . . . . . . . . . . 62
6.4.15. requestCredDeleg . . . . . . . . . . . . . . . . . . 63 7.4.14. requestSequenceDet . . . . . . . . . . . . . . . . . 62
6.4.16. requestAnonymity . . . . . . . . . . . . . . . . . . 63 7.4.15. requestCredDeleg . . . . . . . . . . . . . . . . . . 63
6.4.17. requestConf . . . . . . . . . . . . . . . . . . . . . 63 7.4.16. requestAnonymity . . . . . . . . . . . . . . . . . . 63
6.4.18. requestInteg . . . . . . . . . . . . . . . . . . . . 64 7.4.17. requestConf . . . . . . . . . . . . . . . . . . . . . 63
6.4.19. requestLifetime . . . . . . . . . . . . . . . . . . . 64 7.4.18. requestInteg . . . . . . . . . . . . . . . . . . . . 64
6.4.20. setChannelBinding . . . . . . . . . . . . . . . . . . 64 7.4.19. requestLifetime . . . . . . . . . . . . . . . . . . . 64
6.4.21. getCredDelegState . . . . . . . . . . . . . . . . . . 64 7.4.20. setChannelBinding . . . . . . . . . . . . . . . . . . 64
6.4.22. getMutualAuthState . . . . . . . . . . . . . . . . . 65 7.4.21. getCredDelegState . . . . . . . . . . . . . . . . . . 64
6.4.23. getReplayDetState . . . . . . . . . . . . . . . . . . 65 7.4.22. getMutualAuthState . . . . . . . . . . . . . . . . . 65
6.4.24. getSequenceDetState . . . . . . . . . . . . . . . . . 65 7.4.23. getReplayDetState . . . . . . . . . . . . . . . . . . 65
6.4.25. getAnonymityState . . . . . . . . . . . . . . . . . . 65 7.4.24. getSequenceDetState . . . . . . . . . . . . . . . . . 65
6.4.26. isTransferable . . . . . . . . . . . . . . . . . . . 65 7.4.25. getAnonymityState . . . . . . . . . . . . . . . . . . 65
6.4.27. isProtReady . . . . . . . . . . . . . . . . . . . . . 66 7.4.26. isTransferable . . . . . . . . . . . . . . . . . . . 65
6.4.28. getConfState . . . . . . . . . . . . . . . . . . . . 66 7.4.27. isProtReady . . . . . . . . . . . . . . . . . . . . . 66
6.4.29. getIntegState . . . . . . . . . . . . . . . . . . . . 66 7.4.28. getConfState . . . . . . . . . . . . . . . . . . . . 66
6.4.30. getLifetime . . . . . . . . . . . . . . . . . . . . . 66 7.4.29. getIntegState . . . . . . . . . . . . . . . . . . . . 66
6.4.31. getSrcName . . . . . . . . . . . . . . . . . . . . . 66 7.4.30. getLifetime . . . . . . . . . . . . . . . . . . . . . 66
6.4.32. getTargName . . . . . . . . . . . . . . . . . . . . . 67 7.4.31. getSrcName . . . . . . . . . . . . . . . . . . . . . 66
6.4.33. getMech . . . . . . . . . . . . . . . . . . . . . . . 67 7.4.32. getTargName . . . . . . . . . . . . . . . . . . . . . 67
6.4.34. getDelegCred . . . . . . . . . . . . . . . . . . . . 67 7.4.33. getMech . . . . . . . . . . . . . . . . . . . . . . . 67
6.4.35. isInitiator . . . . . . . . . . . . . . . . . . . . . 67 7.4.34. getDelegCred . . . . . . . . . . . . . . . . . . . . 67
6.4.36. Example Code . . . . . . . . . . . . . . . . . . . . 67 7.4.35. isInitiator . . . . . . . . . . . . . . . . . . . . . 67
6.5. public class MessageProp . . . . . . . . . . . . . . . . 69 7.4.36. Example Code . . . . . . . . . . . . . . . . . . . . 67
6.5.1. Constructors . . . . . . . . . . . . . . . . . . . . 70 7.5. public class MessageProp . . . . . . . . . . . . . . . . 69
6.5.2. getQOP . . . . . . . . . . . . . . . . . . . . . . . 70 7.5.1. Constructors . . . . . . . . . . . . . . . . . . . . 70
6.5.3. getPrivacy . . . . . . . . . . . . . . . . . . . . . 70 7.5.2. getQOP . . . . . . . . . . . . . . . . . . . . . . . 70
6.5.4. getMinorStatus . . . . . . . . . . . . . . . . . . . 70 7.5.3. getPrivacy . . . . . . . . . . . . . . . . . . . . . 70
6.5.5. getMinorString . . . . . . . . . . . . . . . . . . . 70 7.5.4. getMinorStatus . . . . . . . . . . . . . . . . . . . 70
6.5.6. setQOP . . . . . . . . . . . . . . . . . . . . . . . 71 7.5.5. getMinorString . . . . . . . . . . . . . . . . . . . 70
6.5.7. setPrivacy . . . . . . . . . . . . . . . . . . . . . 71 7.5.6. setQOP . . . . . . . . . . . . . . . . . . . . . . . 71
6.5.8. isDuplicateToken . . . . . . . . . . . . . . . . . . 71 7.5.7. setPrivacy . . . . . . . . . . . . . . . . . . . . . 71
6.5.9. isOldToken . . . . . . . . . . . . . . . . . . . . . 71 7.5.8. isDuplicateToken . . . . . . . . . . . . . . . . . . 71
6.5.10. isUnseqToken . . . . . . . . . . . . . . . . . . . . 71 7.5.9. isOldToken . . . . . . . . . . . . . . . . . . . . . 71
6.5.11. isGapToken . . . . . . . . . . . . . . . . . . . . . 71 7.5.10. isUnseqToken . . . . . . . . . . . . . . . . . . . . 71
6.5.12. setSupplementaryStates . . . . . . . . . . . . . . . 72 7.5.11. isGapToken . . . . . . . . . . . . . . . . . . . . . 71
6.6. public class ChannelBinding . . . . . . . . . . . . . . . 72 7.5.12. setSupplementaryStates . . . . . . . . . . . . . . . 72
6.6.1. Constructors . . . . . . . . . . . . . . . . . . . . 73 7.6. public class ChannelBinding . . . . . . . . . . . . . . . 72
6.6.2. getInitiatorAddress . . . . . . . . . . . . . . . . . 73 7.6.1. Constructors . . . . . . . . . . . . . . . . . . . . 73
6.6.3. getAcceptorAddress . . . . . . . . . . . . . . . . . 73 7.6.2. getInitiatorAddress . . . . . . . . . . . . . . . . . 73
6.6.4. getApplicationData . . . . . . . . . . . . . . . . . 74 7.6.3. getAcceptorAddress . . . . . . . . . . . . . . . . . 73
6.6.5. equals . . . . . . . . . . . . . . . . . . . . . . . 74 7.6.4. getApplicationData . . . . . . . . . . . . . . . . . 74
6.7. public class Oid . . . . . . . . . . . . . . . . . . . . 74 7.6.5. equals . . . . . . . . . . . . . . . . . . . . . . . 74
6.7.1. Constructors . . . . . . . . . . . . . . . . . . . . 74 7.7. public class Oid . . . . . . . . . . . . . . . . . . . . 74
6.7.2. toString . . . . . . . . . . . . . . . . . . . . . . 75 7.7.1. Constructors . . . . . . . . . . . . . . . . . . . . 74
6.7.3. equals . . . . . . . . . . . . . . . . . . . . . . . 75 7.7.2. toString . . . . . . . . . . . . . . . . . . . . . . 75
6.7.4. getDER . . . . . . . . . . . . . . . . . . . . . . . 76 7.7.3. equals . . . . . . . . . . . . . . . . . . . . . . . 75
6.7.5. containedIn . . . . . . . . . . . . . . . . . . . . . 76 7.7.4. getDER . . . . . . . . . . . . . . . . . . . . . . . 76
6.8. public class GSSException extends Exception . . . . . . . 76 7.7.5. containedIn . . . . . . . . . . . . . . . . . . . . . 76
6.8.1. Static Constants . . . . . . . . . . . . . . . . . . 76 7.8. public class GSSException extends Exception . . . . . . . 76
6.8.2. Constructors . . . . . . . . . . . . . . . . . . . . 79 7.8.1. Static Constants . . . . . . . . . . . . . . . . . . 76
6.8.3. getMajor . . . . . . . . . . . . . . . . . . . . . . 80 7.8.2. Constructors . . . . . . . . . . . . . . . . . . . . 79
6.8.4. getMinor . . . . . . . . . . . . . . . . . . . . . . 80 7.8.3. getMajor . . . . . . . . . . . . . . . . . . . . . . 80
6.8.5. getMajorString . . . . . . . . . . . . . . . . . . . 80 7.8.4. getMinor . . . . . . . . . . . . . . . . . . . . . . 80
6.8.6. getMinorString . . . . . . . . . . . . . . . . . . . 80 7.8.5. getMajorString . . . . . . . . . . . . . . . . . . . 80
6.8.7. getOutputToken . . . . . . . . . . . . . . . . . . . 81 7.8.6. getMinorString . . . . . . . . . . . . . . . . . . . 80
6.8.8. setMinor . . . . . . . . . . . . . . . . . . . . . . 81 7.8.7. getOutputToken . . . . . . . . . . . . . . . . . . . 81
6.8.9. toString . . . . . . . . . . . . . . . . . . . . . . 81 7.8.8. setMinor . . . . . . . . . . . . . . . . . . . . . . 81
6.8.10. getMessage . . . . . . . . . . . . . . . . . . . . . 81 7.8.9. toString . . . . . . . . . . . . . . . . . . . . . . 81
7. Sample Applications . . . . . . . . . . . . . . . . . . . . . 81 7.8.10. getMessage . . . . . . . . . . . . . . . . . . . . . 81
7.1. Simple GSS Context Initiator . . . . . . . . . . . . . . 82
7.2. Simple GSS Context Acceptor . . . . . . . . . . . . . . . 85 8. Sample Applications . . . . . . . . . . . . . . . . . . . . . 81
8. Security Considerations . . . . . . . . . . . . . . . . . . . 89 8.1. Simple GSS Context Initiator . . . . . . . . . . . . . . 82
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 90 8.2. Simple GSS Context Acceptor . . . . . . . . . . . . . . . 85
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 90 9. Security Considerations . . . . . . . . . . . . . . . . . . . 89
11. Changes since RFC 5653 . . . . . . . . . . . . . . . . . . . 90 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 90
12. Changes since RFC 2853 . . . . . . . . . . . . . . . . . . . 92 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 90
13. References . . . . . . . . . . . . . . . . . . . . . . . . . 92 12. Changes since RFC 5653 . . . . . . . . . . . . . . . . . . . 90
13.1. Normative References . . . . . . . . . . . . . . . . . . 92 13. Changes since RFC 2853 . . . . . . . . . . . . . . . . . . . 92
13.2. Informative References . . . . . . . . . . . . . . . . . 93 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 92
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 93 14.1. Normative References . . . . . . . . . . . . . . . . . . 92
14.2. Informative References . . . . . . . . . . . . . . . . . 93
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 94
1. Introduction 1. Introduction
This document specifies Java language bindings for the Generic This document specifies Java language bindings for the Generic
Security Services Application Programming Interface version 2 (GSS- Security Services Application Programming Interface version 2 (GSS-
API). GSS-API version 2 is described in a language-independent API). GSS-API version 2 is described in a language-independent
format in RFC 2743 [RFC2743]. The GSS-API allows a caller format in RFC 2743 [RFC2743]. The GSS-API allows a caller
application to authenticate a principal identity, to delegate rights application to authenticate a principal identity, to delegate rights
to a peer, and to apply security services such as confidentiality and to a peer, and to apply security services such as confidentiality and
integrity on a per-message basis. integrity on a per-message basis.
skipping to change at page 7, line 17 skipping to change at page 7, line 19
Cryptography Architecture (JCA) provider model to support the Cryptography Architecture (JCA) provider model to support the
plugability of mechanisms. Mechanisms can be added on a system-wide plugability of mechanisms. Mechanisms can be added on a system-wide
basis, where all users of the framework will have them available. basis, where all users of the framework will have them available.
The specification also allows for the addition of mechanisms per- The specification also allows for the addition of mechanisms per-
instance of the GSS-API. instance of the GSS-API.
Lastly, this specification presents an API that will naturally fit Lastly, this specification presents an API that will naturally fit
within the operation environment of the Java platform. Readers are within the operation environment of the Java platform. Readers are
assumed to be familiar with both the GSS-API and the Java platform. assumed to be familiar with both the GSS-API and the Java platform.
2. GSS-API Operational Paradigm 2. Notational Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
3. GSS-API Operational Paradigm
"Generic Security Service Application Programming Interface, Version "Generic Security Service Application Programming Interface, Version
2" [RFC2743] defines a generic security API to calling applications. 2" [RFC2743] defines a generic security API to calling applications.
It allows a communicating application to authenticate the user It allows a communicating application to authenticate the user
associated with another application, to delegate rights to another associated with another application, to delegate rights to another
application, and to apply security services such as confidentiality application, and to apply security services such as confidentiality
and integrity on a per-message basis. and integrity on a per-message basis.
There are four stages to using GSS-API: There are four stages to using GSS-API:
skipping to change at page 8, line 36 skipping to change at page 8, line 47
protection and validate the data. protection and validate the data.
4) At the completion of a communications session (which may extend 4) At the completion of a communications session (which may extend
across several transport connections), each application uses a across several transport connections), each application uses a
GSSContext method to invalidate the security context and release GSSContext method to invalidate the security context and release
any system or cryptographic resources held. Multiple contexts may any system or cryptographic resources held. Multiple contexts may
also be used (either successively or simultaneously) within a also be used (either successively or simultaneously) within a
single communications association, at the discretion of the single communications association, at the discretion of the
applications. applications.
3. Additional Controls 4. Additional Controls
This section discusses the optional services that a context initiator This section discusses the OPTIONAL services that a context initiator
may request of the GSS-API before the context establishment. Each of may request of the GSS-API before the context establishment. Each of
these services is requested by calling the appropriate mutator method these services is requested by calling the appropriate mutator method
in the GSSContext object before the first call to init is performed. in the GSSContext object before the first call to init is performed.
Only the context initiator can request context flags. Only the context initiator can request context flags.
The optional services defined are: The OPTIONAL services defined are:
Delegation: The (usually temporary) transfer of rights from Delegation: The (usually temporary) transfer of rights from
initiator to acceptor, enabling the acceptor to authenticate initiator to acceptor, enabling the acceptor to authenticate
itself as an agent of the initiator. itself as an agent of the initiator.
Mutual Authentication: In addition to the initiator authenticating Mutual Authentication: In addition to the initiator authenticating
its identity to the context acceptor, the context acceptor should its identity to the context acceptor, the context acceptor SHOULD
also authenticate itself to the initiator. also authenticate itself to the initiator.
Replay Detection: In addition to providing message integrity Replay Detection: In addition to providing message integrity
services, GSSContext per-message operations of getMIC and wrap services, GSSContext per-message operations of getMIC and wrap
should include message numbering information to enable verifyMIC SHOULD include message numbering information to enable verifyMIC
and unwrap to detect if a message has been duplicated. and unwrap to detect if a message has been duplicated.
Out-of-Sequence Detection: In addition to providing message Out-of-Sequence Detection: In addition to providing message
integrity services, GSSContext per-message operations (getMIC and integrity services, GSSContext per-message operations (getMIC and
wrap) should include message sequencing information to enable wrap) SHOULD include message sequencing information to enable
verifyMIC and unwrap to detect if a message has been received out verifyMIC and unwrap to detect if a message has been received out
of sequence. of sequence.
Anonymous Authentication: The establishment of the security Anonymous Authentication: The establishment of the security
context should not reveal the initiator's identity to the context context SHOULD NOT reveal the initiator's identity to the context
acceptor. acceptor.
Some mechanisms may not support all optional services, and some Some mechanisms may not support all OPTIONAL services, and some
mechanisms may only support some services in conjunction with others. mechanisms may only support some services in conjunction with others.
The GSSContext interface offers query methods to allow the The GSSContext interface offers query methods to allow the
verification by the calling application of which services will be verification by the calling application of which services will be
available from the context when the establishment phase is complete. available from the context when the establishment phase is complete.
In general, if the security mechanism is capable of providing a In general, if the security mechanism is capable of providing a
requested service, it should do so even if additional services must requested service, it SHOULD do so even if additional services must
be enabled in order to provide the requested service. If the be enabled in order to provide the requested service. If the
mechanism is incapable of providing a requested service, it should mechanism is incapable of providing a requested service, it SHOULD
proceed without the service leaving the application to abort the proceed without the service leaving the application to abort the
context establishment process if it considers the requested service context establishment process if it considers the requested service
to be mandatory. to be mandatory.
Some mechanisms may specify that support for some services is Some mechanisms MAY specify that support for some services is
optional, and that implementors of the mechanism need not provide it. optional, and that implementors of the mechanism need not provide it.
This is most commonly true of the confidentiality service, often This is most commonly true of the confidentiality service, often
because of legal restrictions on the use of data-encryption, but may because of legal restrictions on the use of data-encryption, but may
apply to any of the services. Such mechanisms are required to send apply to any of the services. Such mechanisms are required to send
at least one token from acceptor to initiator during context at least one token from acceptor to initiator during context
establishment when the initiator indicates a desire to use such a establishment when the initiator indicates a desire to use such a
service, so that the initiating GSS-API can correctly indicate service, so that the initiating GSS-API can correctly indicate
whether the service is supported by the acceptor's GSS-API. whether the service is supported by the acceptor's GSS-API.
3.1. Delegation 4.1. Delegation
The GSS-API allows delegation to be controlled by the initiating The GSS-API allows delegation to be controlled by the initiating
application via the requestCredDeleg method before the first call to application via the requestCredDeleg method before the first call to
init has been issued. Some mechanisms do not support delegation, and init has been issued. Some mechanisms do not support delegation, and
for such mechanisms, attempts by an application to enable delegation for such mechanisms, attempts by an application to enable delegation
are ignored. are ignored.
The acceptor of a security context, for which the initiator enabled The acceptor of a security context, for which the initiator enabled
delegation, can check if delegation was enabled by using the delegation, can check if delegation was enabled by using the
getCredDelegState method of the GSSContext interface. In cases when getCredDelegState method of the GSSContext interface. In cases when
skipping to change at page 10, line 25 skipping to change at page 10, line 33
on the underlying mechanism, the identity embodied by the delegated on the underlying mechanism, the identity embodied by the delegated
credential may be either "A" or "B acting for A". credential may be either "A" or "B acting for A".
For many mechanisms that support delegation, a simple boolean does For many mechanisms that support delegation, a simple boolean does
not provide enough control. Examples of additional aspects of not provide enough control. Examples of additional aspects of
delegation control that a mechanism might provide to an application delegation control that a mechanism might provide to an application
are duration of delegation, network addresses from which delegation are duration of delegation, network addresses from which delegation
is valid, and constraints on the tasks that may be performed by a is valid, and constraints on the tasks that may be performed by a
delegate. Such controls are presently outside the scope of the GSS- delegate. Such controls are presently outside the scope of the GSS-
API. GSS-API implementations supporting mechanisms offering API. GSS-API implementations supporting mechanisms offering
additional controls should provide extension routines that allow additional controls SHOULD provide extension routines that allow
these controls to be exercised (perhaps by modifying the initiator's these controls to be exercised (perhaps by modifying the initiator's
GSS-API credential object prior to its use in establishing a GSS-API credential object prior to its use in establishing a
context). However, the simple delegation control provided by GSS-API context). However, the simple delegation control provided by GSS-API
should always be able to override other mechanism-specific delegation SHOULD always be able to override other mechanism-specific delegation
controls. If the application instructs the GSSContext object that controls. If the application instructs the GSSContext object that
delegation is not desired, then the implementation must not permit delegation is not desired, then the implementation MUST NOT permit
delegation to occur. This is an exception to the general rule that a delegation to occur. This is an exception to the general rule that a
mechanism may enable services even if they are not requested -- mechanism may enable services even if they are not requested --
delegation may only be provided at the explicit request of the delegation may only be provided at the explicit request of the
application. application.
3.2. Mutual Authentication 4.2. Mutual Authentication
Usually, a context acceptor will require that a context initiator Usually, a context acceptor will require that a context initiator
authenticate itself so that the acceptor may make an access-control authenticate itself so that the acceptor may make an access-control
decision prior to performing a service for the initiator. In some decision prior to performing a service for the initiator. In some
cases, the initiator may also request that the acceptor authenticate cases, the initiator may also request that the acceptor authenticate
itself. GSS-API allows the initiating application to request this itself. GSS-API allows the initiating application to request this
mutual authentication service by calling the requestMutualAuth method mutual authentication service by calling the requestMutualAuth method
of the GSSContext interface with a "true" parameter before making the of the GSSContext interface with a "true" parameter before making the
first call to init. The initiating application is informed as to first call to init. The initiating application is informed as to
whether or not the context acceptor has authenticated itself. Note whether or not the context acceptor has authenticated itself. Note
that some mechanisms may not support mutual authentication, and other that some mechanisms may not support mutual authentication, and other
mechanisms may always perform mutual authentication, whether or not mechanisms may always perform mutual authentication, whether or not
the initiating application requests it. In particular, mutual the initiating application requests it. In particular, mutual
authentication may be required by some mechanisms in order to support authentication may be required by some mechanisms in order to support
replay or out-of-sequence message detection, and for such mechanisms, replay or out-of-sequence message detection, and for such mechanisms,
a request for either of these services will automatically enable a request for either of these services will automatically enable
mutual authentication. mutual authentication.
3.3. Replay and Out-of-Sequence Detection 4.3. Replay and Out-of-Sequence Detection
The GSS-API may provide detection of mis-ordered messages once a The GSS-API MAY provide detection of mis-ordered messages once a
security context has been established. Protection may be applied to security context has been established. Protection MAY be applied to
messages by either application, by calling either getMIC or wrap messages by either application, by calling either getMIC or wrap
methods of the GSSContext interface, and verified by the peer methods of the GSSContext interface, and verified by the peer
application by calling verifyMIC or unwrap for the peer's GSSContext application by calling verifyMIC or unwrap for the peer's GSSContext
object. object.
The getMIC method calculates a cryptographic checksum (authentication The getMIC method calculates a cryptographic checksum (authentication
tag) of an application message, and returns that checksum in a token. tag) of an application message, and returns that checksum in a token.
The application should pass both the token and the message to the The application SHOULD pass both the token and the message to the
peer application, which presents them to the verifyMIC method of the peer application, which presents them to the verifyMIC method of the
peer's GSSContext object. peer's GSSContext object.
The wrap method calculates a cryptographic checksum of an application The wrap method calculates a cryptographic checksum of an application
message, and places both the checksum and the message inside a single message, and places both the checksum and the message inside a single
token. The application should pass the token to the peer token. The application SHOULD pass the token to the peer
application, which presents it to the unwrap method of the peer's application, which presents it to the unwrap method of the peer's
GSSContext object to extract the message and verify the checksum. GSSContext object to extract the message and verify the checksum.
Either pair of routines may be capable of detecting out-of-sequence Either pair of routines may be capable of detecting out-of-sequence
message delivery or the duplication of messages. Details of such message delivery or the duplication of messages. Details of such
mis-ordered messages are indicated through supplementary query mis-ordered messages are indicated through supplementary query
methods of the MessageProp object that is filled in by each of these methods of the MessageProp object that is filled in by each of these
routines. routines.
A mechanism need not maintain a list of all tokens that have been A mechanism need not maintain a list of all tokens that have been
processed in order to support these status codes. A typical processed in order to support these status codes. A typical
mechanism might retain information about only the most recent "N" mechanism might retain information about only the most recent "N"
tokens processed, allowing it to distinguish duplicates and missing tokens processed, allowing it to distinguish duplicates and missing
tokens within the most recent "N" messages; the receipt of a token tokens within the most recent "N" messages; the receipt of a token
older than the most recent "N" would result in the isOldToken method older than the most recent "N" would result in the isOldToken method
of the instance of MessageProp to return "true". of the instance of MessageProp to return "true".
3.4. Anonymous Authentication 4.4. Anonymous Authentication
In certain situations, an application may wish to initiate the In certain situations, an application may wish to initiate the
authentication process to authenticate a peer, without revealing its authentication process to authenticate a peer, without revealing its
own identity. As an example, consider an application providing own identity. As an example, consider an application providing
access to a database containing medical information and offering access to a database containing medical information and offering
unrestricted access to the service. A client of such a service might unrestricted access to the service. A client of such a service might
wish to authenticate the service (in order to establish trust in any wish to authenticate the service (in order to establish trust in any
information retrieved from it), but might not wish the service to be information retrieved from it), but might not wish the service to be
able to obtain the client's identity (perhaps due to privacy concerns able to obtain the client's identity (perhaps due to privacy concerns
about the specific inquiries, or perhaps simply to avoid being placed about the specific inquiries, or perhaps simply to avoid being placed
skipping to change at page 12, line 31 skipping to change at page 12, line 41
class), the getSrcName method of the acceptor's GSSContext object class), the getSrcName method of the acceptor's GSSContext object
will, for such contexts, return a reserved internal-form name, will, for such contexts, return a reserved internal-form name,
defined by the implementation. defined by the implementation.
The toString method for a GSSName object representing an anonymous The toString method for a GSSName object representing an anonymous
entity will return a printable name. The returned value will be entity will return a printable name. The returned value will be
syntactically distinguishable from any valid principal name supported syntactically distinguishable from any valid principal name supported
by the implementation. The associated name-type object identifier by the implementation. The associated name-type object identifier
will be an oid representing the value of NT_ANONYMOUS. This name- will be an oid representing the value of NT_ANONYMOUS. This name-
type oid will be defined as a public, static Oid object of the type oid will be defined as a public, static Oid object of the
GSSName class. The printable form of an anonymous name should be GSSName class. The printable form of an anonymous name SHOULD be
chosen such that it implies anonymity, since this name may appear in, chosen such that it implies anonymity, since this name may appear in,
for example, audit logs. For example, the string "<anonymous>" might for example, audit logs. For example, the string "<anonymous>" might
be a good choice, if no valid printable names supported by the be a good choice, if no valid printable names supported by the
implementation can begin with "<" and end with ">". implementation can begin with "<" and end with ">".
When using the equal method of the GSSName interface, and one of the When using the equal method of the GSSName interface, and one of the
operands is a GSSName instance representing an anonymous entity, the operands is a GSSName instance representing an anonymous entity, the
method must return "false". method MUST return "false".
3.5. Integrity and Confidentiality 4.5. Integrity and Confidentiality
If a GSSContext supports the integrity service, getMic method may be If a GSSContext supports the integrity service, getMic method may be
used to create message integrity check tokens on application used to create message integrity check tokens on application
messages. messages.
If a GSSContext supports the confidentiality service, wrap method may If a GSSContext supports the confidentiality service, wrap method may
be used to encrypt application messages. Messages are selectively be used to encrypt application messages. Messages are selectively
encrypted, under the control of the setPrivacy method of the encrypted, under the control of the setPrivacy method of the
MessageProp object used in the wrap method. Confidentiality will be MessageProp object used in the wrap method. Confidentiality will be
applied if the privacy state is set to true. applied if the privacy state is set to true.
3.6. Inter-process Context Transfer 4.6. Inter-process Context Transfer
GSS-APIv2 provides functionality that allows a security context to be GSS-APIv2 provides functionality that allows a security context to be
transferred between processes on a single machine. These are transferred between processes on a single machine. These are
implemented using the export method of GSSContext and a byte array implemented using the export method of GSSContext and a byte array
constructor of the same class. The most common use for such a constructor of the same class. The most common use for such a
feature is a client-server design where the server is implemented as feature is a client-server design where the server is implemented as
a single process that accepts incoming security contexts, which then a single process that accepts incoming security contexts, which then
launches child processes to deal with the data on these contexts. In launches child processes to deal with the data on these contexts. In
such a design, the child processes must have access to the security such a design, the child processes must have access to the security
context object created within the parent so that they can use per- context object created within the parent so that they can use per-
skipping to change at page 13, line 34 skipping to change at page 13, line 46
subsequently, and to create an inter-process token containing subsequently, and to create an inter-process token containing
information needed by the adopting process to successfully recreate information needed by the adopting process to successfully recreate
the context. After successful completion of export, the original the context. After successful completion of export, the original
security context is made inaccessible to the calling process by GSS- security context is made inaccessible to the calling process by GSS-
API, and any further usage of this object will result in failures. API, and any further usage of this object will result in failures.
The originating process transfers the inter-process token to the The originating process transfers the inter-process token to the
adopting process, which creates a new GSSContext object using the adopting process, which creates a new GSSContext object using the
byte array constructor. The properties of the context are equivalent byte array constructor. The properties of the context are equivalent
to that of the original context. to that of the original context.
The inter-process token may contain sensitive data from the original The inter-process token MAY contain sensitive data from the original
security context (including cryptographic keys). Applications using security context (including cryptographic keys). Applications using
inter-process tokens to transfer security contexts must take inter-process tokens to transfer security contexts MUST take
appropriate steps to protect these tokens in transit. appropriate steps to protect these tokens in transit.
Implementations are not required to support the inter-process Implementations are not required to support the inter-process
transfer of security contexts. Calling the isTransferable method of transfer of security contexts. Calling the isTransferable method of
the GSSContext interface will indicate if the context object is the GSSContext interface will indicate if the context object is
transferable. transferable.
3.7. The Use of Incomplete Contexts 4.7. The Use of Incomplete Contexts
Some mechanisms may allow the per-message services to be used before Some mechanisms may allow the per-message services to be used before
the context establishment process is complete. For example, a the context establishment process is complete. For example, a
mechanism may include sufficient information in its initial context- mechanism may include sufficient information in its initial context-
level tokens for the context acceptor to immediately decode messages level tokens for the context acceptor to immediately decode messages
protected with wrap or getMIC. For such a mechanism, the initiating protected with wrap or getMIC. For such a mechanism, the initiating
application need not wait until subsequent context-level tokens have application need not wait until subsequent context-level tokens have
been sent and received before invoking the per-message protection been sent and received before invoking the per-message protection
services. services.
An application can invoke the isProtReady method of the GSSContext An application can invoke the isProtReady method of the GSSContext
class to determine if the per-message services are available in class to determine if the per-message services are available in
advance of complete context establishment. Applications wishing to advance of complete context establishment. Applications wishing to
use per-message protection services on partially established contexts use per-message protection services on partially established contexts
should query this method before attempting to invoke wrap or getMIC. SHOULD query this method before attempting to invoke wrap or getMIC.
4. Calling Conventions 5. Calling Conventions
Java provides the implementors with not just a syntax for the Java provides the implementors with not just a syntax for the
language, but also an operational environment. For example, memory language, but also an operational environment. For example, memory
is automatically managed and does not require application is automatically managed and does not require application
intervention. These language features have allowed for a simpler API intervention. These language features have allowed for a simpler API
and have led to the elimination of certain GSS-API functions. and have led to the elimination of certain GSS-API functions.
Moreover, the JCA defines a provider model that allows for Moreover, the JCA defines a provider model that allows for
implementation-independent access to security services. Using this implementation-independent access to security services. Using this
model, applications can seamlessly switch between different model, applications can seamlessly switch between different
implementations and dynamically add new services. The GSS-API implementations and dynamically add new services. The GSS-API
specification leverages these concepts by the usage of providers for specification leverages these concepts by the usage of providers for
the mechanism implementations. the mechanism implementations.
4.1. Package Name 5.1. Package Name
The classes and interfaces defined in this document reside in the The classes and interfaces defined in this document reside in the
package called "org.ietf.jgss". Applications that wish to make use package called "org.ietf.jgss". Applications that wish to make use
of this API should import this package name as shown in section 7. of this API should import this package name as shown in section 8.
4.2. Provider Framework 5.2. Provider Framework
The Java security API's use a provider architecture that allows The Java security API's use a provider architecture that allows
applications to be implementation independent and security API applications to be implementation independent and security API
implementations to be modular and extensible. The implementations to be modular and extensible. The
java.security.Provider class is an abstract class that a vendor java.security.Provider class is an abstract class that a vendor
extends. This class maps various properties that represent different extends. This class maps various properties that represent different
security services that are available to the names of the actual security services that are available to the names of the actual
vendor classes that implement those services. When requesting a vendor classes that implement those services. When requesting a
service, an application simply specifies the desired provider and the service, an application simply specifies the desired provider and the
API delegates the request to service classes available from that API delegates the request to service classes available from that
skipping to change at page 15, line 23 skipping to change at page 15, line 33
How the GSS-API locates and queries these providers is beyond the How the GSS-API locates and queries these providers is beyond the
scope of this document and is being deferred to a Service Provider scope of this document and is being deferred to a Service Provider
Interface (SPI) specification. The availability of such an SPI Interface (SPI) specification. The availability of such an SPI
specification is not mandatory for the adoption of this API specification is not mandatory for the adoption of this API
specification nor is it mandatory to use providers in the specification nor is it mandatory to use providers in the
implementation of a GSS-API framework. However, by using the implementation of a GSS-API framework. However, by using the
provider framework together with an SPI specification, one can create provider framework together with an SPI specification, one can create
an extensible and implementation-independent GSS-API framework. an extensible and implementation-independent GSS-API framework.
4.3. Integer Types 5.3. Integer Types
All numeric values are declared as "int" primitive Java type. The All numeric values are declared as "int" primitive Java type. The
Java specification guarantees that this will be a 32-bit two's Java specification guarantees that this will be a 32-bit two's
complement signed number. complement signed number.
Throughout this API, the "boolean" primitive Java type is used Throughout this API, the "boolean" primitive Java type is used
wherever a boolean value is required or returned. wherever a boolean value is required or returned.
4.4. Opaque Data Types 5.4. Opaque Data Types
Java byte arrays are used to represent opaque data types that are Java byte arrays are used to represent opaque data types that are
consumed and produced by the GSS-API in the form of tokens. Java consumed and produced by the GSS-API in the form of tokens. Java
arrays contain a length field that enables the users to easily arrays contain a length field that enables the users to easily
determine their size. The language has automatic garbage collection determine their size. The language has automatic garbage collection
that alleviates the need by developers to release memory and that alleviates the need by developers to release memory and
simplifies buffer ownership issues. simplifies buffer ownership issues.
4.5. Strings 5.5. Strings
The String object will be used to represent all textual data. The The String object will be used to represent all textual data. The
Java String object transparently treats all characters as two-byte Java String object transparently treats all characters as two-byte
Unicode characters, which allows support for many locals. All Unicode characters, which allows support for many locals. All
routines returning or accepting textual data will use the String routines returning or accepting textual data will use the String
object. object.
4.6. Object Identifiers 5.6. Object Identifiers
An Oid object will be used to represent Universal Object Identifiers An Oid object will be used to represent Universal Object Identifiers
(Oids). Oids are ISO-defined, hierarchically globally interpretable (Oids). Oids are ISO-defined, hierarchically globally interpretable
identifiers used within the GSS-API framework to identify security identifiers used within the GSS-API framework to identify security
mechanisms and name formats. The Oid object can be created from a mechanisms and name formats. The Oid object can be created from a
string representation of its dot notation (e.g., "1.3.6.1.5.6.2") as string representation of its dot notation (e.g., "1.3.6.1.5.6.2") as
well as from its ASN.1 DER encoding. Methods are also provided to well as from its ASN.1 DER encoding. Methods are also provided to
test equality and provide the DER representation for the object. test equality and provide the DER representation for the object.
An important feature of the Oid class is that its instances are An important feature of the Oid class is that its instances are
immutable -- i.e., there are no methods defined that allow one to immutable -- i.e., there are no methods defined that allow one to
change the contents of an Oid. This property allows one to treat change the contents of an Oid. This property allows one to treat
these objects as "statics" without the need to perform copies. these objects as "statics" without the need to perform copies.
Certain routines allow the usage of a default oid. A "null" value Certain routines allow the usage of a default oid. A "null" value
can be used in those cases. can be used in those cases.
4.7. Object Identifier Sets 5.7. Object Identifier Sets
The Java bindings represent object identifier sets as arrays of Oid The Java bindings represent object identifier sets as arrays of Oid
objects. All Java arrays contain a length field, which allows for objects. All Java arrays contain a length field, which allows for
easy manipulation and reference. easy manipulation and reference.
In order to support the full functionality of RFC 2743 [RFC2743], the In order to support the full functionality of RFC 2743 [RFC2743], the
Oid class includes a method that checks for existence of an Oid Oid class includes a method that checks for existence of an Oid
object within a specified array. This is equivalent in functionality object within a specified array. This is equivalent in functionality
to gss_test_oid_set_member. The use of Java arrays and Java's to gss_test_oid_set_member. The use of Java arrays and Java's
automatic garbage collection has eliminated the need for the automatic garbage collection has eliminated the need for the
following routines: gss_create_empty_oid_set, gss_release_oid_set, following routines: gss_create_empty_oid_set, gss_release_oid_set,
and gss_add_oid_set_member. Java GSS-API implementations will not and gss_add_oid_set_member. Java GSS-API implementations will not
contain them. Java's automatic garbage collection and the immutable contain them. Java's automatic garbage collection and the immutable
property of the Oid object eliminates the memory management issues of property of the Oid object eliminates the memory management issues of
the C counterpart. the C counterpart.
Whenever a default value for an Object Identifier Set is required, a Whenever a default value for an Object Identifier Set is required, a
"null" value can be used. Please consult the detailed method "null" value can be used. Please consult the detailed method
description for details. description for details.
4.8. Credentials 5.8. Credentials
GSS-API credentials are represented by the GSSCredential interface. GSS-API credentials are represented by the GSSCredential interface.
The interface contains several constructs to allow for the creation The interface contains several constructs to allow for the creation
of most common credential objects for the initiator and the acceptor. of most common credential objects for the initiator and the acceptor.
Comparisons are performed using the interface's "equals" method. The Comparisons are performed using the interface's "equals" method. The
following general description of GSS-API credentials is included from following general description of GSS-API credentials is included from
the C-bindings specification: the C-bindings specification:
GSS-API credentials can contain mechanism-specific principal GSS-API credentials can contain mechanism-specific principal
authentication data for multiple mechanisms. A GSS-API credential authentication data for multiple mechanisms. A GSS-API credential
skipping to change at page 17, line 21 skipping to change at page 17, line 30
mechanism to authenticate a single principal, and conceptually mechanism to authenticate a single principal, and conceptually
contains two credential-references that describe the actual contains two credential-references that describe the actual
mechanism-specific authentication data, one to be used by GSS-API mechanism-specific authentication data, one to be used by GSS-API
for initiating contexts, and one to be used for accepting for initiating contexts, and one to be used for accepting
contexts. For mechanisms that do not distinguish between acceptor contexts. For mechanisms that do not distinguish between acceptor
and initiator credentials, both references would point to the same and initiator credentials, both references would point to the same
underlying mechanism-specific authentication data. underlying mechanism-specific authentication data.
Credentials describe a set of mechanism-specific principals, and give Credentials describe a set of mechanism-specific principals, and give
their holder the ability to act as any of those principals. All their holder the ability to act as any of those principals. All
principal identities asserted by a single GSS-API credential should principal identities asserted by a single GSS-API credential SHOULD
belong to the same entity, although enforcement of this property is belong to the same entity, although enforcement of this property is
an implementation-specific matter. A single GSSCredential object an implementation-specific matter. A single GSSCredential object
represents all the credential elements that have been acquired. represents all the credential elements that have been acquired.
The creation of an GSSContext object allows the value of "null" to be The creation of an GSSContext object allows the value of "null" to be
specified as the GSSCredential input parameter. This will indicate a specified as the GSSCredential input parameter. This will indicate a
desire by the application to act as a default principal. While desire by the application to act as a default principal. While
individual GSS-API implementations are free to determine such default individual GSS-API implementations are free to determine such default
behavior as appropriate to the mechanism, the following default behavior as appropriate to the mechanism, the following default
behavior by these routines is recommended for portability: behavior by these routines is RECOMMENDED for portability:
For the initiator side of the context: For the initiator side of the context:
1) If there is only a single principal capable of initiating security 1) If there is only a single principal capable of initiating security
contexts for the chosen mechanism that the application is contexts for the chosen mechanism that the application is
authorized to act on behalf of, then that principal shall be used; authorized to act on behalf of, then that principal shall be used;
otherwise, otherwise,
2) If the platform maintains a concept of a default network-identity 2) If the platform maintains a concept of a default network-identity
for the chosen mechanism, and if the application is authorized to for the chosen mechanism, and if the application is authorized to
skipping to change at page 18, line 34 skipping to change at page 18, line 44
4) A user-configurable default identity shall be used. 4) A user-configurable default identity shall be used.
The purpose of the above rules is to allow security contexts to be The purpose of the above rules is to allow security contexts to be
established by both initiator and acceptor using the default behavior established by both initiator and acceptor using the default behavior
whenever possible. Applications requesting default behavior are whenever possible. Applications requesting default behavior are
likely to be more portable across mechanisms and implementations than likely to be more portable across mechanisms and implementations than
ones that instantiate an GSSCredential object representing a specific ones that instantiate an GSSCredential object representing a specific
identity. identity.
4.9. Contexts 5.9. Contexts
The GSSContext interface is used to represent one end of a GSS-API The GSSContext interface is used to represent one end of a GSS-API
security context, storing state information appropriate to that end security context, storing state information appropriate to that end
of the peer communication, including cryptographic state information. of the peer communication, including cryptographic state information.
The instantiation of the context object is done differently by the The instantiation of the context object is done differently by the
initiator and the acceptor. After the context has been instantiated, initiator and the acceptor. After the context has been instantiated,
the initiator may choose to set various context options that will the initiator MAY choose to set various context options that will
determine the characteristics of the desired security context. When determine the characteristics of the desired security context. When
all the application-desired characteristics have been set, the all the application-desired characteristics have been set, the
initiator will call the initSecContext method, which will produce a initiator will call the initSecContext method, which will produce a
token for consumption by the peer's acceptSecContext method. It is token for consumption by the peer's acceptSecContext method. It is
the responsibility of the application to deliver the authentication the responsibility of the application to deliver the authentication
token(s) between the peer applications for processing. Upon token(s) between the peer applications for processing. Upon
completion of the context-establishment phase, context attributes can completion of the context-establishment phase, context attributes can
be retrieved, by both the initiator and acceptor, using the accessor be retrieved, by both the initiator and acceptor, using the accessor
methods. These will reflect the actual attributes of the established methods. These will reflect the actual attributes of the established
context and might not match the initiator-requested values. If any context and might not match the initiator-requested values. If any
retrieved attribute does not match the desired value but it is retrieved attribute does not match the desired value but it is
necessary for the application protocol, the application should necessary for the application protocol, the application SHOULD
destroy the security context and not use it for application traffic. destroy the security context and not use it for application traffic.
Otherwise, at this point, the context can be used by the application Otherwise, at this point, the context can be used by the application
to apply cryptographic services to its data. to apply cryptographic services to its data.
4.10. Authentication Tokens 5.10. Authentication Tokens
A token is a caller-opaque type that GSS-API uses to maintain A token is a caller-opaque type that GSS-API uses to maintain
synchronization between each end of the GSS-API security context. synchronization between each end of the GSS-API security context.
The token is a cryptographically protected octet-string, generated by The token is a cryptographically protected octet-string, generated by
the underlying mechanism at one end of a GSS-API security context for the underlying mechanism at one end of a GSS-API security context for
use by the peer mechanism at the other end. Encapsulation (if use by the peer mechanism at the other end. Encapsulation (if
required) within the application protocol and transfer of the token required) within the application protocol and transfer of the token
are the responsibility of the peer applications. are the responsibility of the peer applications.
Java GSS-API uses byte arrays to represent authentication tokens. Java GSS-API uses byte arrays to represent authentication tokens.
4.11. Inter-Process Tokens 5.11. Inter-Process Tokens
Certain GSS-API routines are intended to transfer data between Certain GSS-API routines are intended to transfer data between
processes in multi-process programs. These routines use a caller- processes in multi-process programs. These routines use a caller-
opaque octet-string, generated by the GSS-API in one process for use opaque octet-string, generated by the GSS-API in one process for use
by the GSS-API in another process. The calling application is by the GSS-API in another process. The calling application is
responsible for transferring such tokens between processes. Note responsible for transferring such tokens between processes. Note
that, while GSS-API implementors are encouraged to avoid placing that, while GSS-API implementors are encouraged to avoid placing
sensitive information within inter-process tokens, or to sensitive information within inter-process tokens, or to
cryptographically protect them, many implementations will be unable cryptographically protect them, many implementations will be unable
to avoid placing key material or other sensitive data within them. to avoid placing key material or other sensitive data within them.
It is the application's responsibility to ensure that inter-process It is the application's responsibility to ensure that inter-process
tokens are protected in transit, and transferred only to processes tokens are protected in transit, and transferred only to processes
that are trustworthy. An inter-process token is represented using a that are trustworthy. An inter-process token is represented using a
byte array emitted from the export method of the GSSContext byte array emitted from the export method of the GSSContext
interface. The receiver of the inter-process token would initialize interface. The receiver of the inter-process token would initialize
an GSSContext object with this token to create a new context. Once a an GSSContext object with this token to create a new context. Once a
context has been exported, the GSSContext object is invalidated and context has been exported, the GSSContext object is invalidated and
is no longer available. is no longer available.
4.12. Error Reporting 5.12. Error Reporting
RFC 2743 [RFC2743] defined the usage of major and minor status values RFC 2743 [RFC2743] defined the usage of major and minor status values
for the signaling of GSS-API errors. The major code, also called GSS for the signaling of GSS-API errors. The major code, also called GSS
status code, is used to signal errors at the GSS-API level, status code, is used to signal errors at the GSS-API level,
independent of the underlying mechanism(s). The minor status value independent of the underlying mechanism(s). The minor status value
or Mechanism status code, is a mechanism-defined error value or Mechanism status code, is a mechanism-defined error value
indicating a mechanism-specific error code. indicating a mechanism-specific error code.
Java GSS-API uses exceptions implemented by the GSSException class to Java GSS-API uses exceptions implemented by the GSSException class to
signal both minor and major error values. Both mechanism-specific signal both minor and major error values. Both mechanism-specific
errors and GSS-API level errors are signaled through instances of errors and GSS-API level errors are signaled through instances of
this class. The usage of exceptions replaces the need for major and this class. The usage of exceptions replaces the need for major and
minor codes to be used within the API calls. The GSSException class minor codes to be used within the API calls. The GSSException class
also contains methods to obtain textual representations for both the also contains methods to obtain textual representations for both the
major and minor values, which is equivalent to the functionality of major and minor values, which is equivalent to the functionality of
gss_display_status. A GSSException object may also include an output gss_display_status. A GSSException object MAY also include an output
token that should be sent to the peer. token that SHOULD be sent to the peer.
If an exception is thrown during context establishment, the context If an exception is thrown during context establishment, the context
negotiation has failed and the GSSContext object must be abandoned. negotiation has failed and the GSSContext object MUST be abandoned.
If it is thrown in a per-message call, the context can remain useful. If it is thrown in a per-message call, the context MAY remain useful.
4.12.1. GSS Status Codes 5.12.1. GSS Status Codes
GSS status codes indicate errors that are independent of the GSS status codes indicate errors that are independent of the
underlying mechanism(s) used to provide the security service. The underlying mechanism(s) used to provide the security service. The
errors that can be indicated via a GSS status code are generic API errors that can be indicated via a GSS status code are generic API
routine errors (errors that are defined in the GSS-API routine errors (errors that are defined in the GSS-API
specification). These bindings take advantage of the Java exceptions specification). These bindings take advantage of the Java exceptions
mechanism, thus, eliminating the need for calling errors. mechanism, thus, eliminating the need for calling errors.
A GSS status code indicates a single fatal generic API error from the A GSS status code indicates a single fatal generic API error from the
routine that has thrown the GSSException. Using exceptions announces routine that has thrown the GSSException. Using exceptions announces
skipping to change at page 22, line 34 skipping to change at page 22, line 46
The GSS major status code of FAILURE is used to indicate that the The GSS major status code of FAILURE is used to indicate that the
underlying mechanism detected an error for which no specific GSS underlying mechanism detected an error for which no specific GSS
status code is defined. The mechanism-specific status code can status code is defined. The mechanism-specific status code can
provide more details about the error. provide more details about the error.
The different major status codes that can be contained in the The different major status codes that can be contained in the
GSSException object thrown by the methods in this specification are GSSException object thrown by the methods in this specification are
the same as the major status codes returned by the corresponding the same as the major status codes returned by the corresponding
calls in RFC 2743 [RFC2743]. calls in RFC 2743 [RFC2743].
4.12.2. Mechanism-Specific Status Codes 5.12.2. Mechanism-Specific Status Codes
Mechanism-specific status codes are communicated in two ways, they Mechanism-specific status codes are communicated in two ways, they
are part of any GSSException thrown from the mechanism-specific layer are part of any GSSException thrown from the mechanism-specific layer
to signal a fatal error, or they are part of the MessageProp object to signal a fatal error, or they are part of the MessageProp object
that the per-message calls use to signal non-fatal errors. that the per-message calls use to signal non-fatal errors.
A default value of 0 in either the GSSException object or the A default value of 0 in either the GSSException object or the
MessageProp object will be used to represent the absence of any MessageProp object will be used to represent the absence of any
mechanism-specific status code. mechanism-specific status code.
4.12.3. Supplementary Status Codes 5.12.3. Supplementary Status Codes
Supplementary status codes are confined to the per-message methods of Supplementary status codes are confined to the per-message methods of
the GSSContext interface. Because of the informative nature of these the GSSContext interface. Because of the informative nature of these
errors it is not appropriate to use exceptions to signal them. errors it is not appropriate to use exceptions to signal them.
Instead, the per-message operations of the GSSContext interface Instead, the per-message operations of the GSSContext interface
return these values in a MessageProp object. return these values in a MessageProp object.
The MessageProp class defines query methods that return boolean The MessageProp class defines query methods that return boolean
values indicating the following supplementary states: values indicating the following supplementary states:
skipping to change at page 23, line 24 skipping to change at page 23, line 36
| | | | | |
| isOldToken | The token's validity period has expired. | | isOldToken | The token's validity period has expired. |
| | | | | |
| isUnseqToken | A later token has already been processed. | | isUnseqToken | A later token has already been processed. |
| | | | | |
| isGapToken | An expected per-message token was not | | isGapToken | An expected per-message token was not |
| | received. | | | received. |
+------------------+------------------------------------------------+ +------------------+------------------------------------------------+
A "true" return value for any of the above methods indicates that the A "true" return value for any of the above methods indicates that the
token exhibited the specified property. The application must token exhibited the specified property. The application MUST
determine the appropriate course of action for these supplementary determine the appropriate course of action for these supplementary
values. They are not treated as errors by the GSS-API. values. They are not treated as errors by the GSS-API.
4.13. Names 5.13. Names
A name is used to identify a person or entity. GSS-API authenticates A name is used to identify a person or entity. GSS-API authenticates
the relationship between a name and the entity claiming the name. the relationship between a name and the entity claiming the name.
Since different authentication mechanisms may employ different Since different authentication mechanisms may employ different
namespaces for identifying their principals, GSS-API's naming support namespaces for identifying their principals, GSS-API's naming support
is necessarily complex in multi-mechanism environments (or even in is necessarily complex in multi-mechanism environments (or even in
some single-mechanism environments where the underlying mechanism some single-mechanism environments where the underlying mechanism
supports multiple namespaces). supports multiple namespaces).
Two distinct conceptual representations are defined for names: Two distinct conceptual representations are defined for names:
1) A GSS-API form represented by implementations of the GSSName 1) A GSS-API form represented by implementations of the GSSName
interface: A single GSSName object may contain multiple names from interface: A single GSSName object MAY contain multiple names from
different namespaces, but all names should refer to the same different namespaces, but all names SHOULD refer to the same
entity. An example of such an internal name would be the name entity. An example of such an internal name would be the name
returned from a call to the getName method of the GSSCredential returned from a call to the getName method of the GSSCredential
interface, when applied to a credential containing credential interface, when applied to a credential containing credential
elements for multiple authentication mechanisms employing elements for multiple authentication mechanisms employing
different namespaces. This GSSName object will contain a distinct different namespaces. This GSSName object will contain a distinct
name for the entity for each authentication mechanism. name for the entity for each authentication mechanism.
For GSS-API implementations supporting multiple namespaces, For GSS-API implementations supporting multiple namespaces,
GSSName implementations must contain sufficient information to GSSName implementations MUST contain sufficient information to
determine the namespace to which each primitive name belongs. determine the namespace to which each primitive name belongs.
2) Mechanism-specific contiguous byte array and string forms: 2) Mechanism-specific contiguous byte array and string forms:
Different GSSName initialization methods are provided to handle Different GSSName initialization methods are provided to handle
both byte array and string formats and to accommodate various both byte array and string formats and to accommodate various
calling applications and name types. These formats are capable of calling applications and name types. These formats are capable of
containing only a single name (from a single namespace). containing only a single name (from a single namespace).
Contiguous string names are always accompanied by an object Contiguous string names are always accompanied by an object
identifier specifying the namespace to which the name belongs, and identifier specifying the namespace to which the name belongs, and
their format is dependent on the authentication mechanism that their format is dependent on the authentication mechanism that
skipping to change at page 24, line 29 skipping to change at page 24, line 39
communication with their users. The byte array name formats are communication with their users. The byte array name formats are
assumed to be in non-printable formats (e.g., the byte array assumed to be in non-printable formats (e.g., the byte array
returned from the export method of the GSSName interface). returned from the export method of the GSSName interface).
A GSSName object can be converted to a contiguous representation by A GSSName object can be converted to a contiguous representation by
using the toString method. This will guarantee that the name will be using the toString method. This will guarantee that the name will be
converted to a printable format. Different initialization methods in converted to a printable format. Different initialization methods in
the GSSName interface are defined allowing support for multiple the GSSName interface are defined allowing support for multiple
syntaxes for each supported namespace, and allowing users the freedom syntaxes for each supported namespace, and allowing users the freedom
to choose a preferred name representation. The toString method to choose a preferred name representation. The toString method
should use an implementation-chosen printable syntax for each SHOULD use an implementation-chosen printable syntax for each
supported name type. To obtain the printable name type, supported name type. To obtain the printable name type,
getStringNameType method can be used. getStringNameType method can be used.
There is no guarantee that calling the toString method on the GSSName There is no guarantee that calling the toString method on the GSSName
interface will produce the same string form as the original imported interface will produce the same string form as the original imported
string name. Furthermore, it is possible that the name was not even string name. Furthermore, it is possible that the name was not even
constructed from a string representation. The same applies to constructed from a string representation. The same applies to
namespace identifiers, which may not necessarily survive unchanged namespace identifiers, which may not necessarily survive unchanged
after a journey through the internal name form. An example of this after a journey through the internal name form. An example of this
might be a mechanism that authenticates X.500 names, but provides an might be a mechanism that authenticates X.500 names, but provides an
skipping to change at page 25, line 25 skipping to change at page 25, line 35
returns "true" if the two names being compared refer to the same returns "true" if the two names being compared refer to the same
entity. This is the preferred way to perform name comparisons entity. This is the preferred way to perform name comparisons
instead of using the printable names that a given GSS-API instead of using the printable names that a given GSS-API
implementation may support. Since GSS-API assumes that all primitive implementation may support. Since GSS-API assumes that all primitive
names contained within a given internal name refer to the same names contained within a given internal name refer to the same
entity, equal can return "true" if the two names have at least one entity, equal can return "true" if the two names have at least one
primitive name in common. If the implementation embodies knowledge primitive name in common. If the implementation embodies knowledge
of equivalence relationships between names taken from different of equivalence relationships between names taken from different
namespaces, this knowledge may also allow successful comparisons of namespaces, this knowledge may also allow successful comparisons of
internal names containing no overlapping primitive elements. internal names containing no overlapping primitive elements.
However, applications should note that to avoid surpising behavior, However, applications SHOULD note that to avoid surpising behavior,
it is best to ensure that the names being compared are either both it is best to ensure that the names being compared are either both
mechanism names for the same mechanism, or both internal names that mechanism names for the same mechanism, or both internal names that
are not mechanism names. This holds whether the equals method is are not mechanism names. This holds whether the equals method is
used directly, or the export method is used to generate byte strings used directly, or the export method is used to generate byte strings
that are then compared byte-by-byte. that are then compared byte-by-byte.
When used in large access control lists, the overhead of creating a When used in large access control lists, the overhead of creating a
GSSName object on each name and invoking the equal method on each GSSName object on each name and invoking the equal method on each
name from the Access Control List (ACL) may be prohibitive. As an name from the Access Control List (ACL) may be prohibitive. As an
alternative way of supporting this case, GSS-API defines a special alternative way of supporting this case, GSS-API defines a special
form of the contiguous byte array name, which may be compared form of the contiguous byte array name, which MAY be compared
directly (byte by byte). Contiguous names suitable for comparison directly (byte by byte). Contiguous names suitable for comparison
are generated by the export method. Exported names may be re- are generated by the export method. Exported names MAY be re-
imported by using the byte array constructor and specifying the imported by using the byte array constructor and specifying the
NT_EXPORT_NAME as the name type object identifier. The resulting NT_EXPORT_NAME as the name type object identifier. The resulting
GSSName name will also be a MN. GSSName name will also be a MN.
The GSSName interface defines public static Oid objects representing The GSSName interface defines public static Oid objects representing
the standard name types. Structurally, an exported name object the standard name types. Structurally, an exported name object
consists of a header containing an OID identifying the mechanism that consists of a header containing an OID identifying the mechanism that
authenticated the name, and a trailer containing the name itself, authenticated the name, and a trailer containing the name itself,
where the syntax of the trailer is defined by the individual where the syntax of the trailer is defined by the individual
mechanism specification. Detailed description of the format is mechanism specification. Detailed description of the format is
skipping to change at page 26, line 14 skipping to change at page 26, line 23
Note that the results obtained by using the equals method will in Note that the results obtained by using the equals method will in
general be different from those obtained by invoking canonicalize and general be different from those obtained by invoking canonicalize and
export, and then comparing the byte array output. The first series export, and then comparing the byte array output. The first series
of operation determines whether two (unauthenticated) names identify of operation determines whether two (unauthenticated) names identify
the same principal; the second whether a particular mechanism would the same principal; the second whether a particular mechanism would
authenticate them as the same principal. These two operations will authenticate them as the same principal. These two operations will
in general give the same results only for MNs. in general give the same results only for MNs.
It is important to note that the above are guidelines as to how It is important to note that the above are guidelines as to how
GSSName implementations should behave, and are not intended to be GSSName implementations SHOULD behave, and are not intended to be
specific requirements of how name objects must be implemented. The specific requirements of how name objects must be implemented. The
mechanism designers are free to decide on the details of their mechanism designers are free to decide on the details of their
implementations of the GSSName interface as long as the behavior implementations of the GSSName interface as long as the behavior
satisfies the above guidelines. satisfies the above guidelines.
4.14. Channel Bindings 5.14. Channel Bindings
GSS-API supports the use of user-specified tags to identify a given GSS-API supports the use of user-specified tags to identify a given
context to the peer application. These tags are intended to be used context to the peer application. These tags are intended to be used
to identify the particular communications channel that carries the to identify the particular communications channel that carries the
context. Channel bindings are communicated to the GSS-API using the context. Channel bindings are communicated to the GSS-API using the
ChannelBinding object. The application may use byte arrays to ChannelBinding object. The application MAY use byte arrays to
specify the application data to be used in the channel binding as specify the application data to be used in the channel binding as
well as using instances of the InetAddress. The InetAddress for the well as using instances of the InetAddress. The InetAddress for the
initiator and/or acceptor can be used within an instance of a initiator and/or acceptor can be used within an instance of a
ChannelBinding. ChannelBinding can be set for the GSSContext object ChannelBinding. ChannelBinding can be set for the GSSContext object
using the setChannelBinding method before the first call to init or using the setChannelBinding method before the first call to init or
accept has been performed. Unless the setChannelBinding method has accept has been performed. Unless the setChannelBinding method has
been used to set the ChannelBinding for a GSSContext object, "null" been used to set the ChannelBinding for a GSSContext object, "null"
ChannelBinding will be assumed. InetAddress is currently the only ChannelBinding will be assumed. InetAddress is currently the only
address type defined within the Java platform and as such, it is the address type defined within the Java platform and as such, it is the
only one supported within the ChannelBinding class. Applications only one supported within the ChannelBinding class. Applications
skipping to change at page 27, line 4 skipping to change at page 27, line 12
an octet-string. The mechanism calculates a Message Integrity Code an octet-string. The mechanism calculates a Message Integrity Code
(MIC) over this octet-string and binds the MIC to the context (MIC) over this octet-string and binds the MIC to the context
establishment token emitted by the init method of the GSSContext establishment token emitted by the init method of the GSSContext
interface. The same bindings are set by the context acceptor for its interface. The same bindings are set by the context acceptor for its
GSSContext object and during processing of the accept method, a MIC GSSContext object and during processing of the accept method, a MIC
is calculated in the same way. The calculated MIC is compared with is calculated in the same way. The calculated MIC is compared with
that found in the token, and if the MICs differ, accept will throw a that found in the token, and if the MICs differ, accept will throw a
GSSException with the major code set to BAD_BINDINGS, and the context GSSException with the major code set to BAD_BINDINGS, and the context
will not be established. Some mechanisms may include the actual will not be established. Some mechanisms may include the actual
channel binding data in the token (rather than just a MIC); channel binding data in the token (rather than just a MIC);
applications should therefore not use confidential data as channel- applications SHOULD therefore not use confidential data as channel-
binding components. binding components.
Individual mechanisms may impose additional constraints on addresses Individual mechanisms may impose additional constraints on addresses
that may appear in channel bindings. For example, a mechanism may that may appear in channel bindings. For example, a mechanism may
verify that the initiator address field of the channel binding verify that the initiator address field of the channel binding
contains the correct network address of the host system. Portable contains the correct network address of the host system. Portable
applications should therefore ensure that they either provide correct applications SHOULD therefore ensure that they either provide correct
information for the address fields, or omit the setting of the information for the address fields, or omit the setting of the
addressing information. addressing information.
4.15. Optional Parameters 5.15. Optional Parameters
Whenever the application wishes to omit an optional parameter the Whenever the application wishes to omit an optional parameter the
"null" value shall be used. The detailed method descriptions "null" value SHALL be used. The detailed method descriptions
indicate which parameters are optional. Method overloading has also indicate which parameters are optional. Method overloading has also
been used as a technique to indicate default parameters. been used as a technique to indicate default parameters.
5. Introduction to GSS-API Classes and Interfaces 6. Introduction to GSS-API Classes and Interfaces
This section presents a brief description of the classes and This section presents a brief description of the classes and
interfaces that constitute the GSS-API. The implementations of these interfaces that constitute the GSS-API. The implementations of these
are obtained from the CLASSPATH defined by the application. If Java are obtained from the CLASSPATH defined by the application. If Java
GSS becomes part of the standard Java APIs, then these classes will GSS becomes part of the standard Java APIs, then these classes will
be available by default on all systems as part of the JRE's system be available by default on all systems as part of the JRE's system
classes. classes.
This section also shows the corresponding RFC 2743 [RFC2743] This section also shows the corresponding RFC 2743 [RFC2743]
functionality implemented by each of the classes. Detailed functionality implemented by each of the classes. Detailed
description of these classes and their methods is presented in description of these classes and their methods is presented in
section 6 section 7
5.1. GSSManager Class 6.1. GSSManager Class
This abstract class serves as a factory to instantiate This abstract class serves as a factory to instantiate
implementations of the GSS-API interfaces and also provides methods implementations of the GSS-API interfaces and also provides methods
to make queries about underlying security mechanisms. to make queries about underlying security mechanisms.
A default implementation can be obtained using the static method A default implementation can be obtained using the static method
getInstance(). Applications that desire to provide their own getInstance(). Applications that desire to provide their own
implementation of the GSSManager class can simply extend the abstract implementation of the GSSManager class can simply extend the abstract
class themselves. class themselves.
This class contains equivalents of the following RFC 2743 [RFC2743] This class contains equivalents of the following RFC 2743 [RFC2743]
routines: routines:
+----------------------------+-------------------------+------------+ +----------------------------+-------------------------+------------+
| RFC 2743 Routine | Function | Section(s) | | RFC 2743 Routine | Function | Section(s) |
+----------------------------+-------------------------+------------+ +----------------------------+-------------------------+------------+
| gss_import_name | Create an internal name | 6.1.5 - | | gss_import_name | Create an internal name | 7.1.5 - |
| | from the supplied | 6.1.8 | | | from the supplied | 7.1.8 |
| | information. | | | | information. | |
| | | | | | | |
| gss_acquire_cred | Acquire credential for | 6.1.9 - | | gss_acquire_cred | Acquire credential for | 7.1.9 - |
| | use. | 6.1.11 | | | use. | 7.1.11 |
| | | | | | | |
| gss_import_sec_context | Create a previously | 6.1.14 | | gss_import_sec_context | Create a previously | 7.1.14 |
| | exported context. | | | | exported context. | |
| | | | | | | |
| gss_indicate_mechs | List the mechanisms | 6.1.2 | | gss_indicate_mechs | List the mechanisms | 7.1.2 |
| | supported by this GSS- | | | | supported by this GSS- | |
| | API implementation. | | | | API implementation. | |
| | | | | | | |
| gss_inquire_mechs_for_name | List the mechanisms | 6.1.4 | | gss_inquire_mechs_for_name | List the mechanisms | 7.1.4 |
| | supporting the | | | | supporting the | |
| | specified name type. | | | | specified name type. | |
| | | | | | | |
| gss_inquire_names_for_mech | List the name types | 6.1.3 | | gss_inquire_names_for_mech | List the name types | 7.1.3 |
| | supported by the | | | | supported by the | |
| | specified mechanism. | | | | specified mechanism. | |
+----------------------------+-------------------------+------------+ +----------------------------+-------------------------+------------+
5.2. GSSName Interface 6.2. GSSName Interface
GSS-API names are represented in the Java bindings through the GSS-API names are represented in the Java bindings through the
GSSName interface. Different name formats and their definitions are GSSName interface. Different name formats and their definitions are
identified with Universal Object Identifiers (oids). The format of identified with Universal Object Identifiers (oids). The format of
the names can be derived based on the unique oid of each name type. the names can be derived based on the unique oid of each name type.
The following GSS-API routines are provided by the GSSName interface: The following GSS-API routines are provided by the GSSName interface:
+-----------------------+------------------------------+------------+ +-----------------------+------------------------------+------------+
| RFC 2743 Routine | Function | Section(s) | | RFC 2743 Routine | Function | Section(s) |
+-----------------------+------------------------------+------------+ +-----------------------+------------------------------+------------+
| gss_display_name | Convert internal name | 6.2.6 | | gss_display_name | Convert internal name | 7.2.6 |
| | representation to text | | | | representation to text | |
| | format. | | | | format. | |
| | | | | | | |
| gss_compare_name | Compare two internal names. | 6.2.2, | | gss_compare_name | Compare two internal names. | 7.2.2, |
| | | 6.2.3 | | | | 7.2.3 |
| | | | | | | |
| gss_release_name | Release resources associated | N/A | | gss_release_name | Release resources associated | N/A |
| | with the internal name. | | | | with the internal name. | |
| | | | | | | |
| gss_canonicalize_name | Convert an internal name to | 6.2.4 | | gss_canonicalize_name | Convert an internal name to | 7.2.4 |
| | a mechanism name. | | | | a mechanism name. | |
| | | | | | | |
| gss_export_name | Convert a mechanism name to | 6.2.5 | | gss_export_name | Convert a mechanism name to | 7.2.5 |
| | export format. | | | | export format. | |
| | | | | | | |
| gss_duplicate_name | Create a copy of the | N/A | | gss_duplicate_name | Create a copy of the | N/A |
| | internal name. | | | | internal name. | |
+-----------------------+------------------------------+------------+ +-----------------------+------------------------------+------------+
The gss_release_name call is not provided as Java does its own The gss_release_name call is not provided as Java does its own
garbage collection. The gss_duplicate_name call is also redundant; garbage collection. The gss_duplicate_name call is also redundant;
the GSSName interface has no mutator methods that can change the the GSSName interface has no mutator methods that can change the
state of the object so it is safe for sharing across threads. state of the object so it is safe for sharing across threads.
5.3. GSSCredential Interface 6.3. GSSCredential Interface
The GSSCredential interface is responsible for the encapsulation of The GSSCredential interface is responsible for the encapsulation of
GSS-API credentials. Credentials identify a single entity and GSS-API credentials. Credentials identify a single entity and
provide the necessary cryptographic information to enable the provide the necessary cryptographic information to enable the
creation of a context on behalf of that entity. A single credential creation of a context on behalf of that entity. A single credential
may contain multiple mechanism-specific credentials, each referred to may contain multiple mechanism-specific credentials, each referred to
as a credential element. The GSSCredential interface provides the as a credential element. The GSSCredential interface provides the
functionality of the following GSS-API routines: functionality of the following GSS-API routines:
+--------------------------+---------------------------+------------+ +--------------------------+---------------------------+------------+
| RFC 2743 Routine | Function | Section(s) | | RFC 2743 Routine | Function | Section(s) |
+--------------------------+---------------------------+------------+ +--------------------------+---------------------------+------------+
| gss_add_cred | Constructs credentials | 6.3.11 | | gss_add_cred | Constructs credentials | 7.3.11 |
| | incrementally. | | | | incrementally. | |
| | | | | | | |
| gss_inquire_cred | Obtain information about | 6.3.3 - | | gss_inquire_cred | Obtain information about | 7.3.3 - |
| | credential. | 6.3.10 | | | credential. | 7.3.10 |
| | | | | | | |
| gss_inquire_cred_by_mech | Obtain per-mechanism | 6.3.4 - | | gss_inquire_cred_by_mech | Obtain per-mechanism | 7.3.4 - |
| | information about a | 6.3.9 | | | information about a | 7.3.9 |
| | credential. | | | | credential. | |
| | | | | | | |
| gss_release_cred | Dispose of credentials | 6.3.2 | | gss_release_cred | Dispose of credentials | 7.3.2 |
| | after use. | | | | after use. | |
+--------------------------+---------------------------+------------+ +--------------------------+---------------------------+------------+
5.4. GSSContext Interface 6.4. GSSContext Interface
This interface encapsulates the functionality of context-level calls This interface encapsulates the functionality of context-level calls
required for security context establishment and management between required for security context establishment and management between
peers as well as the per-message services offered to applications. A peers as well as the per-message services offered to applications. A
context is established between a pair of peers and allows the usage context is established between a pair of peers and allows the usage
of security services on a per-message basis on application data. It of security services on a per-message basis on application data. It
is created over a single security mechanism. The GSSContext is created over a single security mechanism. The GSSContext
interface provides the functionality of the following GSS-API interface provides the functionality of the following GSS-API
routines: routines:
+------------------------+-----------------------------+------------+ +------------------------+-----------------------------+------------+
| RFC 2743 Routine | Function | Section(s) | | RFC 2743 Routine | Function | Section(s) |
+------------------------+-----------------------------+------------+ +------------------------+-----------------------------+------------+
| gss_init_sec_context | Initiate the creation of a | 6.4.2 | | gss_init_sec_context | Initiate the creation of a | 7.4.2 |
| | security context with a | | | | security context with a | |
| | peer. | | | | peer. | |
| | | | | | | |
| gss_accept_sec_context | Accept a security context | 6.4.3 | | gss_accept_sec_context | Accept a security context | 7.4.3 |
| | initiated by a peer. | | | | initiated by a peer. | |
| | | | | | | |
| gss_delete_sec_context | Destroy a security context. | 6.4.5 | | gss_delete_sec_context | Destroy a security context. | 7.4.5 |
| | | | | | | |
| gss_context_time | Obtain remaining context | 6.4.30 | | gss_context_time | Obtain remaining context | 7.4.30 |
| | time. | | | | time. | |
| | | | | | | |
| gss_inquire_context | Obtain context | 6.4.21 - | | gss_inquire_context | Obtain context | 7.4.21 - |
| | characteristics. | 6.4.35 | | | characteristics. | 7.4.35 |
| | | | | | | |
| gss_wrap_size_limit | Determine token-size limit | 6.4.6 | | gss_wrap_size_limit | Determine token-size limit | 7.4.6 |
| | for gss_wrap. | | | | for gss_wrap. | |
| | | | | | | |
| gss_export_sec_context | Transfer security context | 6.4.11 | | gss_export_sec_context | Transfer security context | 7.4.11 |
| | to another process. | | | | to another process. | |
| | | | | | | |
| gss_get_mic | Calculate a cryptographic | 6.4.9 | | gss_get_mic | Calculate a cryptographic | 7.4.9 |
| | Message Integrity Code | | | | Message Integrity Code | |
| | (MIC) for a message. | | | | (MIC) for a message. | |
| | | | | | | |
| gss_verify_mic | Verify integrity on a | 6.4.10 | | gss_verify_mic | Verify integrity on a | 7.4.10 |
| | received message. | | | | received message. | |
| | | | | | | |
| gss_wrap | Attach a MIC to a message | 6.4.7 | | gss_wrap | Attach a MIC to a message | 7.4.7 |
| | and optionally encrypt the | | | | and optionally encrypt the | |
| | message content. | | | | message content. | |
| | | | | | | |
| gss_unwrap | Obtain a previously wrapped | 6.4.8 | | gss_unwrap | Obtain a previously wrapped | 7.4.8 |
| | application message | | | | application message | |
| | verifying its integrity and | | | | verifying its integrity and | |
| | optionally decrypting it. | | | | optionally decrypting it. | |
+------------------------+-----------------------------+------------+ +------------------------+-----------------------------+------------+
The functionality offered by the gss_process_context_token routine The functionality offered by the gss_process_context_token routine
has not been included in the Java bindings specification. The has not been included in the Java bindings specification. The
corresponding functionality of gss_delete_sec_context has also been corresponding functionality of gss_delete_sec_context has also been
modified to not return any peer tokens. This has been proposed in modified to not return any peer tokens. This has been proposed in
accordance to the recommendations stated in RFC 2743 [RFC2743]. accordance to the recommendations stated in RFC 2743 [RFC2743].
GSSContext does offer the functionality of destroying the locally GSSContext does offer the functionality of destroying the locally
stored context information. stored context information.
5.5. MessageProp Class 6.5. MessageProp Class
This helper class is used in the per-message operations on the This helper class is used in the per-message operations on the
context. An instance of this class is created by the application and context. An instance of this class is created by the application and
then passed into the per-message calls. In some cases, the then passed into the per-message calls. In some cases, the
application conveys information to the GSS-API implementation through application conveys information to the GSS-API implementation through
this object and in other cases the GSS-API returns information to the this object and in other cases the GSS-API returns information to the
application by setting it in this object. See the description of the application by setting it in this object. See the description of the
per-message operations wrap, unwrap, getMIC, and verifyMIC in the per-message operations wrap, unwrap, getMIC, and verifyMIC in the
GSSContext interfaces for details. GSSContext interfaces for details.
5.6. GSSException Class 6.6. GSSException Class
Exceptions are used in the Java bindings to signal fatal errors to Exceptions are used in the Java bindings to signal fatal errors to
the calling applications. This replaces the major and minor codes the calling applications. This replaces the major and minor codes
used in the C-bindings specification as a method of signaling used in the C-bindings specification as a method of signaling
failures. The GSSException class handles both minor and major codes, failures. The GSSException class handles both minor and major codes,
as well as their translation into textual representation. All GSS- as well as their translation into textual representation. All GSS-
API methods are declared as throwing this exception. API methods are declared as throwing this exception.
+--------------------+----------------------------+-----------------+ +--------------------+----------------------------+-----------------+
| RFC 2743 Routine | Function | Section | | RFC 2743 Routine | Function | Section |
+--------------------+----------------------------+-----------------+ +--------------------+----------------------------+-----------------+
| gss_display_status | Retrieve textual | 6.8.5, 6.8.6, | | gss_display_status | Retrieve textual | 7.8.5, 7.8.6, |
| | representation of error | 6.8.9, 6.8.10 | | | representation of error | 7.8.9, 7.8.10 |
| | codes. | | | | codes. | |
+--------------------+----------------------------+-----------------+ +--------------------+----------------------------+-----------------+
5.7. Oid Class 6.7. Oid Class
This utility class is used to represent Universal Object Identifiers This utility class is used to represent Universal Object Identifiers
and their associated operations. GSS-API uses object identifiers to and their associated operations. GSS-API uses object identifiers to
distinguish between security mechanisms and name types. This class, distinguish between security mechanisms and name types. This class,
aside from being used whenever an object identifier is needed, aside from being used whenever an object identifier is needed,
implements the following GSS-API functionality: implements the following GSS-API functionality:
+-------------------------+-------------------------------+---------+ +-------------------------+-------------------------------+---------+
| RFC 2743 Routine | Function | Section | | RFC 2743 Routine | Function | Section |
+-------------------------+-------------------------------+---------+ +-------------------------+-------------------------------+---------+
| gss_test_oid_set_member | Determine if the specified | 6.7.5 | | gss_test_oid_set_member | Determine if the specified | 7.7.5 |
| | oid is part of a set of oids. | | | | oid is part of a set of oids. | |
+-------------------------+-------------------------------+---------+ +-------------------------+-------------------------------+---------+
5.8. ChannelBinding Class 6.8. ChannelBinding Class
An instance of this class is used to specify channel binding An instance of this class is used to specify channel binding
information to the GSSContext object before the start of a security information to the GSSContext object before the start of a security
context establishment. The application may use a byte array to context establishment. The application may use a byte array to
specify application data to be used in the channel binding as well as specify application data to be used in the channel binding as well as
to use instances of the InetAddress. InetAddress is currently the to use instances of the InetAddress. InetAddress is currently the
only address type defined within the Java platform and as such, it is only address type defined within the Java platform and as such, it is
the only one supported within the ChannelBinding class. Applications the only one supported within the ChannelBinding class. Applications
that use other types of addresses can include them as part of the that use other types of addresses can include them as part of the
application data. application data.
6. Detailed GSS-API Class Description 7. Detailed GSS-API Class Description
This section lists a detailed description of all the public methods This section lists a detailed description of all the public methods
that each of the GSS-API classes and interfaces must provide. that each of the GSS-API classes and interfaces MUST provide.
6.1. public abstract class GSSManager 7.1. public abstract class GSSManager
The GSSManager class is an abstract class that serves as a factory The GSSManager class is an abstract class that serves as a factory
for three GSS interfaces: GSSName, GSSCredential, and GSSContext. It for three GSS interfaces: GSSName, GSSCredential, and GSSContext. It
also provides methods for applications to determine what mechanisms also provides methods for applications to determine what mechanisms
are available from the GSS implementation and what name types these are available from the GSS implementation and what name types these
mechanisms support. An instance of the default GSSManager subclass mechanisms support. An instance of the default GSSManager subclass
may be obtained through the static method getInstance(), but MAY be obtained through the static method getInstance(), but
applications are free to instantiate other subclasses of GSSManager. applications are free to instantiate other subclasses of GSSManager.
All but one method in this class are declared abstract. This means All but one method in this class are declared abstract. This means
that subclasses have to provide the complete implementation for those that subclasses have to provide the complete implementation for those
methods. The only exception to this is the static method methods. The only exception to this is the static method
getInstance(), which will have platform-specific code to return an getInstance(), which will have platform-specific code to return an
instance of the default subclass. instance of the default subclass.
Platform providers of GSS are required not to add any constructors to Platform providers of GSS are REQUIRED not to add any constructors to
this class, private, public, or protected. This will ensure that all this class, private, public, or protected. This will ensure that all
subclasses invoke only the default constructor provided to the base subclasses invoke only the default constructor provided to the base
class by the compiler. class by the compiler.
A subclass extending the GSSManager abstract class may be implemented A subclass extending the GSSManager abstract class MAY be implemented
as a modular provider-based layer that utilizes some well-known as a modular provider-based layer that utilizes some well-known
service provider specification. The GSSManager API provides the service provider specification. The GSSManager API provides the
application with methods to set provider preferences on such an application with methods to set provider preferences on such an
implementation. These methods also allow the implementation to throw implementation. These methods also allow the implementation to throw
a well-defined exception in case provider-based configuration is not a well-defined exception in case provider-based configuration is not
supported. Applications that expect to be portable should be aware supported. Applications that expect to be portable SHOULD be aware
of this and recover cleanly by catching the exception. of this and recover cleanly by catching the exception.
It is envisioned that there will be three most common ways in which It is envisioned that there will be three most common ways in which
providers will be used: providers will be used:
1) The application does not care about what provider is used (the 1) The application does not care about what provider is used (the
default case). default case).
2) The application wants a particular provider to be used 2) The application wants a particular provider to be used
preferentially, either for a particular mechanism or all the time, preferentially, either for a particular mechanism or all the time,
skipping to change at page 34, line 21 skipping to change at page 34, line 21
mechanisms, then it wants to fall back on its own provider. mechanisms, then it wants to fall back on its own provider.
The GSSManager class has two methods that enable these modes of The GSSManager class has two methods that enable these modes of
usage: addProviderAtFront() and addProviderAtEnd(). These methods usage: addProviderAtFront() and addProviderAtEnd(). These methods
have the effect of creating an ordered list of <provider, oid> pairs have the effect of creating an ordered list of <provider, oid> pairs
where each pair indicates a preference of provider for a given oid. where each pair indicates a preference of provider for a given oid.
The use of these methods does not require any knowledge of whatever The use of these methods does not require any knowledge of whatever
service provider specification the GSSManager subclass follows. It service provider specification the GSSManager subclass follows. It
is hoped that these methods will serve the needs of most is hoped that these methods will serve the needs of most
applications. Additional methods may be added to an extended applications. Additional methods MAY be added to an extended
GSSManager that could be part of a service provider specification GSSManager that could be part of a service provider specification
that is standardized later. that is standardized later.
When neither of the methods is called, the implementation should When neither of the methods is called, the implementation SHOULD
choose a default provider for each mechanism it supports. choose a default provider for each mechanism it supports.
6.1.1. getInstance 7.1.1. getInstance
public static GSSManager getInstance() public static GSSManager getInstance()
Returns the default GSSManager implementation. Returns the default GSSManager implementation.
6.1.2. getMechs 7.1.2. getMechs
public abstract Oid[] getMechs() public abstract Oid[] getMechs()
Returns an array of Oid objects indicating the mechanisms available Returns an array of Oid objects indicating the mechanisms available
to GSS-API callers. A "null" value is returned when no mechanism are to GSS-API callers. A "null" value is returned when no mechanism are
available (an example of this would be when mechanism are dynamically available (an example of this would be when mechanism are dynamically
configured, and currently no mechanisms are installed). configured, and currently no mechanisms are installed).
6.1.3. getNamesForMech 7.1.3. getNamesForMech
public abstract Oid[] getNamesForMech(Oid mech) public abstract Oid[] getNamesForMech(Oid mech)
throws GSSException throws GSSException
Returns name type Oid's supported by the specified mechanism. Returns name type Oid's supported by the specified mechanism.
Parameters: Parameters:
mech The Oid object for the mechanism to query. mech The Oid object for the mechanism to query.
6.1.4. getMechsForName 7.1.4. getMechsForName
public abstract Oid[] getMechsForName(Oid nameType) public abstract Oid[] getMechsForName(Oid nameType)
Returns an array of Oid objects corresponding to the mechanisms that Returns an array of Oid objects corresponding to the mechanisms that
support the specific name type. "null" is returned when no mechanisms support the specific name type. "null" is returned when no mechanisms
are found to support the specified name type. are found to support the specified name type.
Parameters: Parameters:
nameType The Oid object for the name type. nameType The Oid object for the name type.
6.1.5. createName 7.1.5. createName
public abstract GSSName createName(String nameStr, Oid nameType) public abstract GSSName createName(String nameStr, Oid nameType)
throws GSSException throws GSSException
Factory method to convert a contiguous string name from the specified Factory method to convert a contiguous string name from the specified
namespace to a GSSName object. In general, the GSSName object namespace to a GSSName object. In general, the GSSName object
created will not be an MN; two examples that are exceptions to this created will not be an MN; two examples that are exceptions to this
are when the namespace type parameter indicates NT_EXPORT_NAME or are when the namespace type parameter indicates NT_EXPORT_NAME or
when the GSS-API implementation is not multi-mechanism. when the GSS-API implementation is not multi-mechanism.
skipping to change at page 35, line 40 skipping to change at page 35, line 40
nameStr The string representing a printable form of the nameStr The string representing a printable form of the
name to create. name to create.
nameType The Oid specifying the namespace of the printable nameType The Oid specifying the namespace of the printable
name is supplied. Note that nameType serves to name is supplied. Note that nameType serves to
describe and qualify the interpretation of the describe and qualify the interpretation of the
input nameStr, it does not necessarily imply a input nameStr, it does not necessarily imply a
type for the output GSSName implementation. The type for the output GSSName implementation. The
"null" value can be used to specify that a "null" value can be used to specify that a
mechanism-specific default printable syntax mechanism-specific default printable syntax
should be assumed by each mechanism that examines SHOULD be assumed by each mechanism that examines
nameStr. nameStr.
6.1.6. createName 7.1.6. createName
public abstract GSSName createName(byte[] name, Oid nameType) public abstract GSSName createName(byte[] name, Oid nameType)
throws GSSException throws GSSException
Factory method to convert a contiguous byte array containing a name Factory method to convert a contiguous byte array containing a name
from the specified namespace to a GSSName object. In general, the from the specified namespace to a GSSName object. In general, the
GSSName object created will not be an MN; two examples that are GSSName object created will not be an MN; two examples that are
exceptions to this are when the namespace type parameter indicates exceptions to this are when the namespace type parameter indicates
NT_EXPORT_NAME or when the GSS-API implementation is not multi- NT_EXPORT_NAME or when the GSS-API implementation is not multi-
mechanism. mechanism.
skipping to change at page 36, line 18 skipping to change at page 36, line 18
name The byte array containing the name to create. name The byte array containing the name to create.
nameType The Oid specifying the namespace of the name nameType The Oid specifying the namespace of the name
supplied in the byte array. Note that nameType supplied in the byte array. Note that nameType
serves to describe and qualify the interpretation serves to describe and qualify the interpretation
of the input name byte array; it does not of the input name byte array; it does not
necessarily imply a type for the output GSSName necessarily imply a type for the output GSSName
implementation. The "null" value can be used to implementation. The "null" value can be used to
specify that a mechanism-specific default syntax specify that a mechanism-specific default syntax
should be assumed by each mechanism that examines SHOULD be assumed by each mechanism that examines
the byte array. the byte array.
6.1.7. createName 7.1.7. createName
public abstract GSSName createName(String nameStr, Oid nameType, public abstract GSSName createName(String nameStr, Oid nameType,
Oid mech) throws GSSException Oid mech) throws GSSException
Factory method to convert a contiguous string name from the specified Factory method to convert a contiguous string name from the specified
namespace to a GSSName object that is a mechanism name (MN). In namespace to a GSSName object that is a mechanism name (MN). In
other words, this method is a utility that does the equivalent of two other words, this method is a utility that does the equivalent of two
steps: the createName described in section 6.1.5, and then also the steps: the createName described in section 7.1.5, and then also the
GSSName.canonicalize() described in section 6.2.4. GSSName.canonicalize() described in section 7.2.4.
Parameters: Parameters:
nameStr The string representing a printable form of the nameStr The string representing a printable form of the
name to create. name to create.
nameType The Oid specifying the namespace of the printable nameType The Oid specifying the namespace of the printable
name supplied. Note that nameType serves to name supplied. Note that nameType serves to
describe and qualify the interpretation of the describe and qualify the interpretation of the
input nameStr; it does not necessarily imply a input nameStr; it does not necessarily imply a
type for the output GSSName implementation. The type for the output GSSName implementation. The
"null" value can be used to specify that a "null" value can be used to specify that a
mechanism-specific default printable syntax mechanism-specific default printable syntax
should be assumed when the mechanism examines SHOULD be assumed when the mechanism examines
nameStr. nameStr.
mech Oid specifying the mechanism for which this name mech Oid specifying the mechanism for which this name
should be created. should be created.
6.1.8. createName 7.1.8. createName
public abstract GSSName createName(byte[] name, Oid nameType, public abstract GSSName createName(byte[] name, Oid nameType,
Oid mech) throws GSSException Oid mech) throws GSSException
Factory method to convert a contiguous byte array containing a name Factory method to convert a contiguous byte array containing a name
from the specified namespace to a GSSName object that is an MN. In from the specified namespace to a GSSName object that is an MN. In
other words, this method is a utility that does the equivalent of two other words, this method is a utility that does the equivalent of two
steps: the createName described in section 6.1.6, and then also the steps: the createName described in section 7.1.6, and then also the
GSSName.canonicalize() described in section 6.2.4. GSSName.canonicalize() described in section 7.2.4.
Parameters: Parameters:
name The byte array representing the name to create. name The byte array representing the name to create.
nameType The Oid specifying the namespace of the name nameType The Oid specifying the namespace of the name
supplied in the byte array. Note that nameType supplied in the byte array. Note that nameType
serves to describe and qualify the interpretation serves to describe and qualify the interpretation
of the input name byte array, it does not of the input name byte array, it does not
necessarily imply a type for the output GSSName necessarily imply a type for the output GSSName
implementation. The "null" value can be used to implementation. The "null" value can be used to
specify that a mechanism-specific default syntax specify that a mechanism-specific default syntax
should be assumed by each mechanism that examines SHOULD be assumed by each mechanism that examines
the byte array. the byte array.
mech Oid specifying the mechanism for which this name mech Oid specifying the mechanism for which this name
should be created. should be created.
6.1.9. createCredential 7.1.9. createCredential
public abstract GSSCredential createCredential(int usage) public abstract GSSCredential createCredential(int usage)
throws GSSException throws GSSException
Factory method for acquiring default credentials. This will cause Factory method for acquiring default credentials. This will cause
the GSS-API to use system-specific defaults for the set of the GSS-API to use system-specific defaults for the set of
mechanisms, name, and a DEFAULT lifetime. mechanisms, name, and a DEFAULT lifetime.
Parameters: Parameters:
usage The intended usage for this credential object. usage The intended usage for this credential object.
The value of this parameter must be one of: The value of this parameter MUST be one of:
GSSCredential.INITIATE_AND_ACCEPT(0), GSSCredential.INITIATE_AND_ACCEPT(0),
GSSCredential.INITIATE_ONLY(1), or GSSCredential.INITIATE_ONLY(1), or
GSSCredential.ACCEPT_ONLY(2) GSSCredential.ACCEPT_ONLY(2)
6.1.10. createCredential 7.1.10. createCredential
public abstract GSSCredential createCredential(GSSName aName, public abstract GSSCredential createCredential(GSSName aName,
int lifetime, Oid mech, int usage) int lifetime, Oid mech, int usage)
throws GSSException throws GSSException
Factory method for acquiring a single mechanism credential. Factory method for acquiring a single mechanism credential.
Parameters: Parameters:
aName Name of the principal for whom this credential is aName Name of the principal for whom this credential is
skipping to change at page 38, line 30 skipping to change at page 38, line 30
remain valid. Use remain valid. Use
GSSCredential.INDEFINITE_LIFETIME to request that GSSCredential.INDEFINITE_LIFETIME to request that
the credentials have the maximum permitted the credentials have the maximum permitted
lifetime. Use GSSCredential.DEFAULT_LIFETIME to lifetime. Use GSSCredential.DEFAULT_LIFETIME to
request default credential lifetime. request default credential lifetime.
mech The oid of the desired mechanism. Use "(Oid) mech The oid of the desired mechanism. Use "(Oid)
null" to request the default mechanism(s). null" to request the default mechanism(s).
usage The intended usage for this credential object. usage The intended usage for this credential object.
The value of this parameter must be one of: The value of this parameter MUST be one of:
GSSCredential.INITIATE_AND_ACCEPT(0), GSSCredential.INITIATE_AND_ACCEPT(0),
GSSCredential.INITIATE_ONLY(1), or GSSCredential.INITIATE_ONLY(1), or
GSSCredential.ACCEPT_ONLY(2) GSSCredential.ACCEPT_ONLY(2)
6.1.11. createCredential 7.1.11. createCredential
public abstract GSSCredential createCredential(GSSName aName, public abstract GSSCredential createCredential(GSSName aName,
int lifetime, Oid[] mechs, int usage) int lifetime, Oid[] mechs, int usage)
throws GSSException throws GSSException
Factory method for acquiring credentials over a set of mechanisms. Factory method for acquiring credentials over a set of mechanisms.
Acquires credentials for each of the mechanisms specified in the Acquires credentials for each of the mechanisms specified in the
array called mechs. To determine the list of mechanisms' for which array called mechs. To determine the list of mechanisms' for which
the acquisition of credentials succeeded, the caller should use the the acquisition of credentials succeeded, the caller should use the
GSSCredential.getMechs() method. GSSCredential.getMechs() method.
skipping to change at page 39, line 18 skipping to change at page 39, line 18
the credentials have the maximum permitted the credentials have the maximum permitted
lifetime. Use GSSCredential.DEFAULT_LIFETIME to lifetime. Use GSSCredential.DEFAULT_LIFETIME to
request default credential lifetime. request default credential lifetime.
mechs The array of mechanisms over which the credential mechs The array of mechanisms over which the credential
is to be acquired. Use "(Oid[]) null" for is to be acquired. Use "(Oid[]) null" for
requesting a system-specific default set of requesting a system-specific default set of
mechanisms. mechanisms.
usage The intended usage for this credential object. usage The intended usage for this credential object.
The value of this parameter must be one of: The value of this parameter MUST be one of:
GSSCredential.INITIATE_AND_ACCEPT(0), GSSCredential.INITIATE_AND_ACCEPT(0),
GSSCredential.INITIATE_ONLY(1), or GSSCredential.INITIATE_ONLY(1), or
GSSCredential.ACCEPT_ONLY(2) GSSCredential.ACCEPT_ONLY(2)
6.1.12. createContext 7.1.12. createContext
public abstract GSSContext createContext(GSSName peer, Oid mech, public abstract GSSContext createContext(GSSName peer, Oid mech,
GSSCredential myCred, int lifetime) GSSCredential myCred, int lifetime)
throws GSSException throws GSSException
Factory method for creating a context on the initiator's side. Factory method for creating a context on the initiator's side.
Context flags may be modified through the mutator methods prior to Context flags may be modified through the mutator methods prior to
calling GSSContext.initSecContext(). calling GSSContext.initSecContext().
Parameters: Parameters:
skipping to change at page 40, line 5 skipping to change at page 40, line 5
to request the default mechanism. to request the default mechanism.
myCred Credentials of the initiator. Use "null" to act myCred Credentials of the initiator. Use "null" to act
as a default initiator principal. as a default initiator principal.
lifetime The request lifetime, in seconds, for the lifetime The request lifetime, in seconds, for the
context. Use GSSContext.INDEFINITE_LIFETIME and context. Use GSSContext.INDEFINITE_LIFETIME and
GSSContext.DEFAULT_LIFETIME to request indefinite GSSContext.DEFAULT_LIFETIME to request indefinite
or default context lifetime. or default context lifetime.
6.1.13. createContext 7.1.13. createContext
public abstract GSSContext createContext(GSSCredential myCred) public abstract GSSContext createContext(GSSCredential myCred)
throws GSSException throws GSSException
Factory method for creating a context on the acceptor' side. The Factory method for creating a context on the acceptor' side. The
context's properties will be determined from the input token supplied context's properties will be determined from the input token supplied
to the accept method. to the accept method.
Parameters: Parameters:
myCred Credentials for the acceptor. Use "null" to act myCred Credentials for the acceptor. Use "null" to act
as a default acceptor principal. as a default acceptor principal.
6.1.14. createContext 7.1.14. createContext
public abstract GSSContext createContext(byte[] interProcessToken) public abstract GSSContext createContext(byte[] interProcessToken)
throws GSSException throws GSSException
Factory method for importing a previously exported context. The Factory method for importing a previously exported context. The
context properties will be determined from the input token and can't context properties will be determined from the input token and can't
be modified through the set methods. be modified through the set methods.
Parameters: Parameters:
interProcessToken The token previously emitted from the export interProcessToken The token previously emitted from the export
method. method.
6.1.15. addProviderAtFront 7.1.15. addProviderAtFront
public abstract void addProviderAtFront(Provider p, Oid mech) public abstract void addProviderAtFront(Provider p, Oid mech)
throws GSSException throws GSSException
This method is used to indicate to the GSSManager that the This method is used to indicate to the GSSManager that the
application would like a particular provider to be used ahead of all application would like a particular provider to be used ahead of all
others when support is desired for the given mechanism. When a value others when support is desired for the given mechanism. When a value
of "null" is used instead of an Oid for the mechanism, the GSSManager of "null" is used instead of an Oid for the mechanism, the GSSManager
must use the indicated provider ahead of all others no matter what MUST use the indicated provider ahead of all others no matter what
the mechanism is. Only when the indicated provider does not support the mechanism is. Only when the indicated provider does not support
the needed mechanism should the GSSManager move on to a different the needed mechanism should the GSSManager move on to a different
provider. provider.
Calling this method repeatedly preserves the older settings but Calling this method repeatedly preserves the older settings but
lowers them in preference thus forming an ordered list of provider lowers them in preference thus forming an ordered list of provider
and Oid pairs that grows at the top. and Oid pairs that grows at the top.
Calling addProviderAtFront with a null Oid will remove all previous Calling addProviderAtFront with a null Oid will remove all previous
preferences that were set for this provider in the GSSManager preferences that were set for this provider in the GSSManager
instance. Calling addProviderAtFront with a non-null Oid will remove instance. Calling addProviderAtFront with a non-null Oid will remove
any previous preference that was set using this mechanism and this any previous preference that was set using this mechanism and this
provider together. provider together.
If the GSSManager implementation does not support an SPI with a If the GSSManager implementation does not support an SPI with a
pluggable provider architecture, it should throw a GSSException with pluggable provider architecture, it SHOULD throw a GSSException with
the status code GSSException.UNAVAILABLE to indicate that the the status code GSSException.UNAVAILABLE to indicate that the
operation is unavailable. operation is unavailable.
Parameters: Parameters:
p The provider instance that should be used p The provider instance that should be used
whenever support is needed for mech. whenever support is needed for mech.
mech The mechanism for which the provider is being mech The mechanism for which the provider is being
set. set.
6.1.15.1. addProviderAtFront Example Code 7.1.15.1. addProviderAtFront Example Code
Suppose an application desired that the provider A always be checked Suppose an application desired that the provider A always be checked
first when any mechanism is needed, it would call: first when any mechanism is needed, it would call:
<CODE BEGINS> <CODE BEGINS>
GSSManager mgr = GSSManager.getInstance(); GSSManager mgr = GSSManager.getInstance();
// mgr may at this point have its own pre-configured list // mgr may at this point have its own pre-configured list
// of provider preferences. The following will prepend to // of provider preferences. The following will prepend to
// any such list: // any such list:
skipping to change at page 42, line 10 skipping to change at page 42, line 10
directly. directly.
Suppose, at a later time, the following call is made to the same Suppose, at a later time, the following call is made to the same
GSSManager instance: GSSManager instance:
<CODE BEGINS> <CODE BEGINS>
mgr.addProviderAtFront(B, null) mgr.addProviderAtFront(B, null)
<CODE ENDS> <CODE ENDS>
then the previous setting with the pair (B, m1) is subsumed by this then the previous setting with the pair (B, m1) is subsumed by this
and should be removed. Effectively, the list of preferences now and SHOULD be removed. Effectively, the list of preferences now
becomes {(B, null), (A, null), ... //followed by the pre-configured becomes {(B, null), (A, null), ... //followed by the pre-configured
list}. list}.
Please note, however, that the following call: Please note, however, that the following call:
<CODE BEGINS> <CODE BEGINS>
mgr.addProviderAtFront(A, m3) mgr.addProviderAtFront(A, m3)
<CODE ENDS> <CODE ENDS>
does not subsume the previous setting of (A, null), and the list will does not subsume the previous setting of (A, null), and the list will
effectively become {(A, m3), (B, null), (A, null), ...} effectively become {(A, m3), (B, null), (A, null), ...}
6.1.16. addProviderAtEnd 7.1.16. addProviderAtEnd
public abstract void addProviderAtEnd(Provider p, Oid mech) public abstract void addProviderAtEnd(Provider p, Oid mech)
throws GSSException throws GSSException
This method is used to indicate to the GSSManager that the This method is used to indicate to the GSSManager that the
application would like a particular provider to be used if no other application would like a particular provider to be used if no other
provider can be found that supports the given mechanism. When a provider can be found that supports the given mechanism. When a
value of "null" is used instead of an Oid for the mechanism, the value of "null" is used instead of an Oid for the mechanism, the
GSSManager must use the indicated provider for any mechanism. GSSManager MUST use the indicated provider for any mechanism.
Calling this method repeatedly preserves the older settings, but Calling this method repeatedly preserves the older settings, but
raises them above newer ones in preference thus forming an ordered raises them above newer ones in preference thus forming an ordered
list of providers and Oid pairs that grows at the bottom. Thus, the list of providers and Oid pairs that grows at the bottom. Thus, the
older provider settings will be utilized first before this one is. older provider settings will be utilized first before this one is.
If there are any previously existing preferences that conflict with If there are any previously existing preferences that conflict with
the preference being set here, then the GSSManager should ignore this the preference being set here, then the GSSManager SHOULD ignore this
request. request.
If the GSSManager implementation does not support an SPI with a If the GSSManager implementation does not support an SPI with a
pluggable provider architecture, it should throw a GSSException with pluggable provider architecture, it SHOULD throw a GSSException with
the status code GSSException.UNAVAILABLE to indicate that the the status code GSSException.UNAVAILABLE to indicate that the
operation is unavailable. operation is unavailable.
Parameters: Parameters:
p The provider instance that should be used p The provider instance that should be used
whenever support is needed for mech. whenever support is needed for mech.
mech The mechanism for which the provider is being mech The mechanism for which the provider is being
set. set.
6.1.16.1. addProviderAtEnd Example Code 7.1.16.1. addProviderAtEnd Example Code
Suppose an application desired that when a mechanism of Oid m1 is Suppose an application desired that when a mechanism of Oid m1 is
needed, the system default providers always be checked first, and needed, the system default providers always be checked first, and
only when they do not support m1 should a provider A be checked. It only when they do not support m1 should a provider A be checked. It
would then make the call: would then make the call:
<CODE BEGINS> <CODE BEGINS>
GSSManager mgr = GSSManager.getInstance(); GSSManager mgr = GSSManager.getInstance();
mgr.addProviderAtEnd(A, m1); mgr.addProviderAtEnd(A, m1);
skipping to change at page 43, line 40 skipping to change at page 43, line 40
null)}. null)}.
Suppose, at a later time, the following call is made to the same Suppose, at a later time, the following call is made to the same
GSSManager instance: GSSManager instance:
<CODE BEGINS> <CODE BEGINS>
mgr.addProviderAtEnd(B, m2) mgr.addProviderAtEnd(B, m2)
<CODE ENDS> <CODE ENDS>
then the previous setting with the pair (B, null) subsumes this; then the previous setting with the pair (B, null) subsumes this;
therefore, this request should be ignored. The same would happen if therefore, this request SHOULD be ignored. The same would happen if
a request is made for the already existing pairs of (A, m1) or (B, a request is made for the already existing pairs of (A, m1) or (B,
null). null).
Please note, however, that the following call: Please note, however, that the following call:
<CODE BEGINS> <CODE BEGINS>
mgr.addProviderAtEnd(A, null) mgr.addProviderAtEnd(A, null)
<CODE ENDS> <CODE ENDS>
is not subsumed by the previous setting of (A, m1) and the list will is not subsumed by the previous setting of (A, m1) and the list will
effectively become {..., (A, m1), (B, null), (A, null)}. effectively become {..., (A, m1), (B, null), (A, null)}.
6.1.17. Example Code 7.1.17. Example Code
<CODE BEGINS> <CODE BEGINS>
GSSManager mgr = GSSManager.getInstance(); GSSManager mgr = GSSManager.getInstance();
// What mechs are available to us? // What mechs are available to us?
Oid[] supportedMechs = mgr.getMechs(); Oid[] supportedMechs = mgr.getMechs();
// Set a preference for the provider to be used when support // Set a preference for the provider to be used when support
// is needed for the mechanisms: // is needed for the mechanisms:
skipping to change at page 44, line 30 skipping to change at page 44, line 30
Provider p = (Provider) (new com.foo.security.Provider()); Provider p = (Provider) (new com.foo.security.Provider());
mgr.addProviderAtFront(p, krb); mgr.addProviderAtFront(p, krb);
mgr.addProviderAtFront(p, spkm1); mgr.addProviderAtFront(p, spkm1);
// What name types does this spkm implementation support? // What name types does this spkm implementation support?
Oid[] nameTypes = mgr.getNamesForMech(spkm1); Oid[] nameTypes = mgr.getNamesForMech(spkm1);
<CODE ENDS> <CODE ENDS>
6.2. public interface GSSName 7.2. public interface GSSName
This interface encapsulates a single GSS-API principal entity. This interface encapsulates a single GSS-API principal entity.
Different name formats and their definitions are identified with Different name formats and their definitions are identified with
Universal Object Identifiers (Oids). The format of the names can be Universal Object Identifiers (Oids). The format of the names can be
derived based on the unique oid of its namespace type. derived based on the unique oid of its namespace type.
6.2.1. Static Constants 7.2.1. Static Constants
public static final Oid NT_HOSTBASED_SERVICE public static final Oid NT_HOSTBASED_SERVICE
Oid indicating a host-based service name form. It is used to Oid indicating a host-based service name form. It is used to
represent services associated with host computers. This name form is represent services associated with host computers. This name form is
constructed using two elements, "service" and "hostname", as follows: constructed using two elements, "service" and "hostname", as follows:
service@hostname service@hostname
Values for the "service" element are registered with the IANA. It Values for the "service" element are registered with the IANA. It
skipping to change at page 45, line 34 skipping to change at page 45, line 34
Name type for representing an anonymous entity. It represents the Name type for representing an anonymous entity. It represents the
following value: { iso(1), org(3), dod(6), internet(1), security(5), following value: { iso(1), org(3), dod(6), internet(1), security(5),
nametypes(6), gss-anonymous-name(3) } nametypes(6), gss-anonymous-name(3) }
public static final Oid NT_EXPORT_NAME public static final Oid NT_EXPORT_NAME
Name type used to indicate an exported name produced by the export Name type used to indicate an exported name produced by the export
method. It represents the following value: { iso(1), org(3), dod(6), method. It represents the following value: { iso(1), org(3), dod(6),
internet(1), security(5), nametypes(6), gss-api-exported-name(4) } internet(1), security(5), nametypes(6), gss-api-exported-name(4) }
6.2.2. equals 7.2.2. equals
public boolean equals(GSSName another) throws GSSException public boolean equals(GSSName another) throws GSSException
Compares two GSSName objects to determine whether they refer to the Compares two GSSName objects to determine whether they refer to the
same entity. This method may throw a GSSException when the names same entity. This method MAY throw a GSSException when the names
cannot be compared. If either of the names represents an anonymous cannot be compared. If either of the names represents an anonymous
entity, the method will return "false". entity, the method will return "false".
Parameters: Parameters:
another GSSName object with which to compare. another GSSName object with which to compare.
6.2.3. equals 7.2.3. equals
public boolean equals(Object another) public boolean equals(Object another)
A variation of the equals method, described in section 6.2.2, that is A variation of the equals method, described in section 7.2.2, that is
provided to override the Object.equals() method that the implementing provided to override the Object.equals() method that the implementing
class will inherit. The behavior is exactly the same as that in class will inherit. The behavior is exactly the same as that in
section 6.2.2 except that no GSSException is thrown; instead, "false" section 7.2.2 except that no GSSException is thrown; instead, "false"
will be returned in the situation where an error occurs. (Note that will be returned in the situation where an error occurs. (Note that
the Java language specification requires that two objects that are the Java language specification requires that two objects that are
equal according to the equals(Object) method must return the same equal according to the equals(Object) method MUST return the same
integer result when the hashCode() method is called on them.) integer result when the hashCode() method is called on them.)
Parameters: Parameters:
another GSSName object with which to compare. another GSSName object with which to compare.
6.2.4. canonicalize 7.2.4. canonicalize
public GSSName canonicalize(Oid mech) throws GSSException public GSSName canonicalize(Oid mech) throws GSSException
Creates a mechanism name (MN) from an arbitrary internal name. This Creates a mechanism name (MN) from an arbitrary internal name. This
is equivalent to using the factory methods described in sections is equivalent to using the factory methods described in sections
6.1.7 or 6.1.8 that take the mechanism name as one of their 7.1.7 or 7.1.8 that take the mechanism name as one of their
parameters. parameters.
Parameters: Parameters:
mech The oid for the mechanism for which the canonical mech The oid for the mechanism for which the canonical
form of the name is requested. form of the name is requested.
6.2.5. export 7.2.5. export
public byte[] export() throws GSSException public byte[] export() throws GSSException
Returns a canonical contiguous byte representation of a mechanism Returns a canonical contiguous byte representation of a mechanism
name (MN), suitable for direct, byte-by-byte comparison by name (MN), suitable for direct, byte-by-byte comparison by
authorization functions. If the name is not an MN, implementations authorization functions. If the name is not an MN, implementations
may throw a GSSException with the NAME_NOT_MN status code. If an MAY throw a GSSException with the NAME_NOT_MN status code. If an
implementation chooses not to throw an exception, it should use some implementation chooses not to throw an exception, it SHOULD use some
system-specific default mechanism to canonicalize the name and then system-specific default mechanism to canonicalize the name and then
export it. The format of the header of the output buffer is export it. The format of the header of the output buffer is
specified in RFC 2743 [RFC2743]. specified in RFC 2743 [RFC2743].
6.2.6. toString 7.2.6. toString
public String toString() public String toString()
Returns a textual representation of the GSSName object. To retrieve Returns a textual representation of the GSSName object. To retrieve
the printed name format, which determines the syntax of the returned the printed name format, which determines the syntax of the returned
string, the getStringNameType method can be used. string, the getStringNameType method can be used.
6.2.7. getStringNameType 7.2.7. getStringNameType
public Oid getStringNameType() throws GSSException public Oid getStringNameType() throws GSSException
Returns the oid representing the type of name returned through the Returns the oid representing the type of name returned through the
toString method. Using this oid, the syntax of the printable name toString method. Using this oid, the syntax of the printable name
can be determined. can be determined.
6.2.8. isAnonymous 7.2.8. isAnonymous
public boolean isAnonymous() public boolean isAnonymous()
Tests if this name object represents an anonymous entity. Returns Tests if this name object represents an anonymous entity. Returns
"true" if this is an anonymous name. "true" if this is an anonymous name.
6.2.9. isMN 7.2.9. isMN
public boolean isMN() public boolean isMN()
Tests if this name object contains only one mechanism element and is Tests if this name object contains only one mechanism element and is
thus a mechanism name as defined by RFC 2743 [RFC2743]. thus a mechanism name as defined by RFC 2743 [RFC2743].
6.2.10. Example Code 7.2.10. Example Code
Included below are code examples utilizing the GSSName interface. Included below are code examples utilizing the GSSName interface.
The code below creates a GSSName, converts it to a mechanism name The code below creates a GSSName, converts it to a mechanism name
(MN), performs a comparison, obtains a printable representation of (MN), performs a comparison, obtains a printable representation of
the name, exports it and then re-imports to obtain a new GSSName. the name, exports it and then re-imports to obtain a new GSSName.
<CODE BEGINS> <CODE BEGINS>
GSSManager mgr = GSSManager.getInstance(); GSSManager mgr = GSSManager.getInstance();
// create a host-based service name // create a host-based service name
skipping to change at page 48, line 37 skipping to change at page 48, line 37
mechName.getStringNameType().toString()); mechName.getStringNameType().toString());
// export the name // export the name
byte[] exportName = mechName.export(); byte[] exportName = mechName.export();
// create a new name object from the exported buffer // create a new name object from the exported buffer
GSSName newName = mgr.createName(exportName, GSSName newName = mgr.createName(exportName,
GSSName.NT_EXPORT_NAME); GSSName.NT_EXPORT_NAME);
<CODE ENDS> <CODE ENDS>
6.3. public interface GSSCredential implements Cloneable 7.3. public interface GSSCredential implements Cloneable
This interface encapsulates the GSS-API credentials for an entity. A This interface encapsulates the GSS-API credentials for an entity. A
credential contains all the necessary cryptographic information to credential contains all the necessary cryptographic information to
enable the creation of a context on behalf of the entity that it enable the creation of a context on behalf of the entity that it
represents. It may contain multiple, distinct, mechanism-specific represents. It MAY contain multiple, distinct, mechanism-specific
credential elements, each containing information for a specific credential elements, each containing information for a specific
security mechanism, but all referring to the same entity. security mechanism, but all referring to the same entity.
A credential may be used to perform context initiation, acceptance, A credential MAY be used to perform context initiation, acceptance,
or both. or both.
GSS-API implementations must impose a local access-control policy on GSS-API implementations MUST impose a local access-control policy on
callers to prevent unauthorized callers from acquiring credentials to callers to prevent unauthorized callers from acquiring credentials to
which they are not entitled. GSS-API credential creation is not which they are not entitled. GSS-API credential creation is not
intended to provide a "login to the network" function, as such a intended to provide a "login to the network" function, as such a
function would involve the creation of new credentials rather than function would involve the creation of new credentials rather than
merely acquiring a handle to existing credentials. Such functions, merely acquiring a handle to existing credentials. Such functions,
if required, should be defined in implementation-specific extensions if required, SHOULD be defined in implementation-specific extensions
to the API. to the API.
If credential acquisition is time-consuming for a mechanism, the If credential acquisition is time-consuming for a mechanism, the
mechanism may choose to delay the actual acquisition until the mechanism MAY choose to delay the actual acquisition until the
credential is required (e.g., by GSSContext). Such mechanism- credential is required (e.g., by GSSContext). Such mechanism-
specific implementation decisions should be invisible to the calling specific implementation decisions SHOULD be invisible to the calling
application; thus, the query methods immediately following the application; thus, the query methods immediately following the
creation of a credential object must return valid credential data, creation of a credential object MUST return valid credential data,
and may therefore incur the overhead of a deferred credential and may therefore incur the overhead of a deferred credential
acquisition. acquisition.
Applications will create a credential object passing the desired Applications will create a credential object passing the desired
parameters. The application can then use the query methods to obtain parameters. The application can then use the query methods to obtain
specific information about the instantiated credential object specific information about the instantiated credential object
(equivalent to the gss_inquire routines). When the credential is no (equivalent to the gss_inquire routines). When the credential is no
longer needed, the application should call the dispose (equivalent to longer needed, the application SHOULD call the dispose (equivalent to
gss_release_cred) method to release any resources held by the gss_release_cred) method to release any resources held by the
credential object and to destroy any cryptographically sensitive credential object and to destroy any cryptographically sensitive
information. information.
Classes implementing this interface also implement the Cloneable Classes implementing this interface also implement the Cloneable
interface. This indicates that the class will support the clone() interface. This indicates that the class will support the clone()
method that will allow the creation of duplicate credentials. This method that will allow the creation of duplicate credentials. This
is useful when called just before the add() call to retain a copy of is useful when called just before the add() call to retain a copy of
the original credential. the original credential.
6.3.1. Static Constants 7.3.1. Static Constants
public static final int INITIATE_AND_ACCEPT public static final int INITIATE_AND_ACCEPT
Credential usage flag requesting that it be able to be used for both Credential usage flag requesting that it be able to be used for both
context initiation and acceptance. The value of this constant is 0. context initiation and acceptance. The value of this constant is 0.
public static final int INITIATE_ONLY public static final int INITIATE_ONLY
Credential usage flag requesting that it be able to be used for Credential usage flag requesting that it be able to be used for
context initiation only. The value of this constant is 1. context initiation only. The value of this constant is 1.
skipping to change at page 50, line 13 skipping to change at page 50, line 13
public static final int DEFAULT_LIFETIME public static final int DEFAULT_LIFETIME
A lifetime constant representing the default credential lifetime. A lifetime constant representing the default credential lifetime.
The value of this constant is 0. The value of this constant is 0.
public static final int INDEFINITE_LIFETIME public static final int INDEFINITE_LIFETIME
A lifetime constant representing indefinite credential lifetime. The A lifetime constant representing indefinite credential lifetime. The
value of this constant is the maximum integer value in Java - value of this constant is the maximum integer value in Java -
Integer.MAX_VALUE. Integer.MAX_VALUE.
6.3.2. dispose 7.3.2. dispose
public void dispose() throws GSSException public void dispose() throws GSSException
Releases any sensitive information that the GSSCredential object may Releases any sensitive information that the GSSCredential object may
be containing. Applications should call this method as soon as the be containing. Applications SHOULD call this method as soon as the
credential is no longer needed to minimize the time any sensitive credential is no longer needed to minimize the time any sensitive
information is maintained. information is maintained.
6.3.3. getName 7.3.3. getName
public GSSName getName() throws GSSException public GSSName getName() throws GSSException
Retrieves the name of the entity that the credential asserts. Retrieves the name of the entity that the credential asserts.
6.3.4. getName 7.3.4. getName
public GSSName getName(Oid mechOID) throws GSSException public GSSName getName(Oid mechOID) throws GSSException
Retrieves a mechanism name of the entity that the credential asserts. Retrieves a mechanism name of the entity that the credential asserts.
Equivalent to calling canonicalize() on the name returned by section Equivalent to calling canonicalize() on the name returned by section
6.3.3. 7.3.3.
Parameters: Parameters:
mechOID The mechanism for which information should be mechOID The mechanism for which information should be
returned. returned.
6.3.5. getRemainingLifetime 7.3.5. getRemainingLifetime
public int getRemainingLifetime() throws GSSException public int getRemainingLifetime() throws GSSException
Returns the remaining lifetime in seconds for a credential. The Returns the remaining lifetime in seconds for a credential. The
remaining lifetime is the minimum lifetime for any of the underlying remaining lifetime is the minimum lifetime for any of the underlying
credential mechanisms. A return value of credential mechanisms. A return value of
GSSCredential.INDEFINITE_LIFETIME indicates that the credential does GSSCredential.INDEFINITE_LIFETIME indicates that the credential does
not expire. A return value of 0 indicates that the credential is not expire. A return value of 0 indicates that the credential is
already expired. already expired.
6.3.6. getRemainingInitLifetime 7.3.6. getRemainingInitLifetime
public int getRemainingInitLifetime(Oid mech) throws GSSException public int getRemainingInitLifetime(Oid mech) throws GSSException
Returns the remaining lifetime in seconds for the credential to Returns the remaining lifetime in seconds for the credential to
remain capable of initiating security contexts under the specified remain capable of initiating security contexts under the specified
mechanism. A return value of GSSCredential.INDEFINITE_LIFETIME mechanism. A return value of GSSCredential.INDEFINITE_LIFETIME
indicates that the credential does not expire for context initiation. indicates that the credential does not expire for context initiation.
A return value of 0 indicates that the credential is already expired. A return value of 0 indicates that the credential is already expired.
Parameters: Parameters:
mechOID The mechanism for which information should be mechOID The mechanism for which information should be
returned. returned.
6.3.7. getRemainingAcceptLifetime 7.3.7. getRemainingAcceptLifetime
public int getRemainingAcceptLifetime(Oid mech) throws GSSException public int getRemainingAcceptLifetime(Oid mech) throws GSSException
Returns the remaining lifetime in seconds for the credential to Returns the remaining lifetime in seconds for the credential to
remain capable of accepting security contexts under the specified remain capable of accepting security contexts under the specified
mechanism. A return value of GSSCredential.INDEFINITE_LIFETIME mechanism. A return value of GSSCredential.INDEFINITE_LIFETIME
indicates that the credential does not expire for context acceptance. indicates that the credential does not expire for context acceptance.
A return value of 0 indicates that the credential is already expired. A return value of 0 indicates that the credential is already expired.
Parameters: Parameters:
mechOID The mechanism for which information should be mechOID The mechanism for which information should be
returned. returned.
6.3.8. getUsage 7.3.8. getUsage
public int getUsage() throws GSSException public int getUsage() throws GSSException
Returns the credential usage flag as a union over all mechanisms. Returns the credential usage flag as a union over all mechanisms.
The return value will be one of GSSCredential.INITIATE_AND_ACCEPT(0), The return value will be one of GSSCredential.INITIATE_AND_ACCEPT(0),
GSSCredential.INITIATE_ONLY(1), or GSSCredential.ACCEPT_ONLY(2). GSSCredential.INITIATE_ONLY(1), or GSSCredential.ACCEPT_ONLY(2).
Specifically, GSSCredential.INITIATE_AND_ACCEPT(0) should be returned Specifically, GSSCredential.INITIATE_AND_ACCEPT(0) SHOULD be returned
as long as there exists one credential element allowing context as long as there exists one credential element allowing context
initiation and one credential element allowing context acceptance. initiation and one credential element allowing context acceptance.
These two credential elements are not necessarily the same one, nor These two credential elements are not necessarily the same one, nor
do they need to use the same mechanism(s). do they need to use the same mechanism(s).
6.3.9. getUsage 7.3.9. getUsage
public int getUsage(Oid mechOID) throws GSSException public int getUsage(Oid mechOID) throws GSSException
Returns the credential usage flag for the specified mechanism only. Returns the credential usage flag for the specified mechanism only.
The return value will be one of GSSCredential.INITIATE_AND_ACCEPT(0), The return value will be one of GSSCredential.INITIATE_AND_ACCEPT(0),
GSSCredential.INITIATE_ONLY(1), or GSSCredential.ACCEPT_ONLY(2). GSSCredential.INITIATE_ONLY(1), or GSSCredential.ACCEPT_ONLY(2).
Parameters: Parameters:
mechOID The mechanism for which information should be mechOID The mechanism for which information should be
returned. returned.
6.3.10. getMechs 7.3.10. getMechs
public Oid[] getMechs() throws GSSException public Oid[] getMechs() throws GSSException
Returns an array of mechanisms supported by this credential. Returns an array of mechanisms supported by this credential.
6.3.11. add 7.3.11. add
public void add(GSSName aName, int initLifetime, int acceptLifetime, public void add(GSSName aName, int initLifetime, int acceptLifetime,
Oid mech, int usage) throws GSSException Oid mech, int usage) throws GSSException
Adds a mechanism-specific credential-element to an existing Adds a mechanism-specific credential-element to an existing
credential. This method allows the construction of credentials one credential. This method allows the construction of credentials one
mechanism at a time. mechanism at a time.
This routine is envisioned to be used mainly by context acceptors This routine is envisioned to be used mainly by context acceptors
during the creation of acceptance credentials, which are to be used during the creation of acceptance credentials, which are to be used
skipping to change at page 53, line 18 skipping to change at page 53, line 18
Use GSSCredential.INDEFINITE_LIFETIME to request Use GSSCredential.INDEFINITE_LIFETIME to request
that the credentials that the credentials
have the maximum permitted lifetime. Use have the maximum permitted lifetime. Use
GSSCredential.DEFAULT_LIFETIME to request default GSSCredential.DEFAULT_LIFETIME to request default
credential lifetime. credential lifetime.
mech The mechanisms over which the credential is to be mech The mechanisms over which the credential is to be
acquired. acquired.
usage The intended usage for this credential object. usage The intended usage for this credential object.
The value of this parameter must be one of: The value of this parameter MUST be one of:
GSSCredential.INITIATE_AND_ACCEPT(0), GSSCredential.INITIATE_AND_ACCEPT(0),
GSSCredential.INITIATE_ONLY(1), or GSSCredential.INITIATE_ONLY(1), or
GSSCredential.ACCEPT_ONLY(2) GSSCredential.ACCEPT_ONLY(2)
6.3.12. equals 7.3.12. equals
public boolean equals(Object another) public boolean equals(Object another)
Tests if this GSSCredential refers to the same entity as the supplied Tests if this GSSCredential refers to the same entity as the supplied
object. The two credentials must be acquired over the same object. The two credentials MUST be acquired over the same
mechanisms and must refer to the same principal. Returns "true" if mechanisms and MUST refer to the same principal. Returns "true" if
the two GSSCredentials refer to the same entity; "false" otherwise. the two GSSCredentials refer to the same entity; "false" otherwise.
(Note that the Java language specification [JLS] requires that two (Note that the Java language specification [JLS] requires that two
objects that are equal according to the equals(Object) method must objects that are equal according to the equals(Object) method MUST
return the same integer result when the hashCode() method is called return the same integer result when the hashCode() method is called
on them.) on them.)
Parameters: Parameters:
another Another GSSCredential object for comparison. another Another GSSCredential object for comparison.
6.3.13. Example Code 7.3.13. Example Code
This example code demonstrates the creation of a GSSCredential This example code demonstrates the creation of a GSSCredential
implementation for a specific entity, querying of its fields, and its implementation for a specific entity, querying of its fields, and its
release when it is no longer needed. release when it is no longer needed.
<CODE BEGINS> <CODE BEGINS>
GSSManager mgr = GSSManager.getInstance(); GSSManager mgr = GSSManager.getInstance();
// start by creating a name object for the entity // start by creating a name object for the entity
GSSName name = mgr.createName("userName", GSSName.NT_USER_NAME); GSSName name = mgr.createName("userName", GSSName.NT_USER_NAME);
skipping to change at page 54, line 29 skipping to change at page 54, line 29
Oid[] mechs = cred.getMechs(); Oid[] mechs = cred.getMechs();
if (mechs != null) { if (mechs != null) {
for (int i = 0; i < mechs.length; i++) for (int i = 0; i < mechs.length; i++)
print(mechs[i].toString()); print(mechs[i].toString());
} }
// release system resources held by the credential // release system resources held by the credential
cred.dispose(); cred.dispose();
<CODE ENDS> <CODE ENDS>
6.4. public interface GSSContext 7.4. public interface GSSContext
This interface encapsulates the GSS-API security context and provides This interface encapsulates the GSS-API security context and provides
the security services (wrap, unwrap, getMIC, verifyMIC) that are the security services (wrap, unwrap, getMIC, verifyMIC) that are
available over the context. Security contexts are established available over the context. Security contexts are established
between peers using locally acquired credentials. Multiple contexts between peers using locally acquired credentials. Multiple contexts
may exist simultaneously between a pair of peers, using the same or may exist simultaneously between a pair of peers, using the same or
different set of credentials. GSS-API functions in a manner different set of credentials. GSS-API functions in a manner
independent of the underlying transport protocol and depends on its independent of the underlying transport protocol and depends on its
calling application to transport its tokens between peers. calling application to transport its tokens between peers.
skipping to change at page 55, line 24 skipping to change at page 55, line 24
operations. This allows applications to use per-message operations operations. This allows applications to use per-message operations
on contexts that aren't fully established. on contexts that aren't fully established.
After the context has been established or the isProtReady() method After the context has been established or the isProtReady() method
returns "true", the query routines can be invoked to determine the returns "true", the query routines can be invoked to determine the
actual characteristics and services of the established context. The actual characteristics and services of the established context. The
application can also start using the per-message methods of wrap and application can also start using the per-message methods of wrap and
getMIC to obtain cryptographic operations on application supplied getMIC to obtain cryptographic operations on application supplied
data. data.
When the context is no longer needed, the application should call When the context is no longer needed, the application SHOULD call
dispose to release any system resources the context may be using. dispose to release any system resources the context may be using.
6.4.1. Static Constants 7.4.1. Static Constants
public static final int DEFAULT_LIFETIME public static final int DEFAULT_LIFETIME
A lifetime constant representing the default context lifetime. The A lifetime constant representing the default context lifetime. The
value of this constant is 0. value of this constant is 0.
public static final int INDEFINITE_LIFETIME public static final int INDEFINITE_LIFETIME
A lifetime constant representing indefinite context lifetime. The A lifetime constant representing indefinite context lifetime. The
value of this constant is the maximum integer value in Java - value of this constant is the maximum integer value in Java -
Integer.MAX_VALUE. Integer.MAX_VALUE.
6.4.2. initSecContext 7.4.2. initSecContext
public byte[] initSecContext(byte[] inputBuf, int offset, int len) public byte[] initSecContext(byte[] inputBuf, int offset, int len)
throws GSSException throws GSSException
Called by the context initiator to start the context creation Called by the context initiator to start the context creation
process. This method may return an output token that the application process. This method MAY return an output token that the application
will need to send to the peer for processing by the accept call. The will need to send to the peer for processing by the accept call. The
application can call isEstablished() to determine if the context application can call isEstablished() to determine if the context
establishment phase is complete for this peer. A return value of establishment phase is complete for this peer. A return value of
"false" from isEstablished() indicates that more tokens are expected "false" from isEstablished() indicates that more tokens are expected
to be supplied to the initSecContext() method. Note that it is to be supplied to the initSecContext() method. Note that it is
possible that the initSecContext() method will return a token for the possible that the initSecContext() method will return a token for the
peer and isEstablished() will return "true" also. This indicates peer and isEstablished() will return "true" also. This indicates
that the token needs to be sent to the peer, but the local end of the that the token needs to be sent to the peer, but the local end of the
context is now fully established. context is now fully established.
Upon completion of the context establishment, the available context Upon completion of the context establishment, the available context
options may be queried through the get methods. options may be queried through the get methods.
A GSSException will be thrown if the call fails. Users should call A GSSException will be thrown if the call fails. Users SHOULD call
its getOutputToken() method to find out if there is a token that can its getOutputToken() method to find out if there is a token that can
be sent to the acceptor to communicate the reason for the error. be sent to the acceptor to communicate the reason for the error.
Parameters: Parameters:
inputBuf Token generated by the peer. This parameter is inputBuf Token generated by the peer. This parameter is
ignored on the first call. ignored on the first call.
offset The offset within the inputBuf where the token offset The offset within the inputBuf where the token
begins. begins.
len The length of the token within the inputBuf len The length of the token within the inputBuf
(starting at the offset). (starting at the offset).
6.4.3. acceptSecContext 7.4.3. acceptSecContext
public byte[] acceptSecContext(byte[] inTok, int offset, int len) public byte[] acceptSecContext(byte[] inTok, int offset, int len)
throws GSSException throws GSSException
Called by the context acceptor upon receiving a token from the peer. Called by the context acceptor upon receiving a token from the peer.
This method may return an output token that the application will need This method MAY return an output token that the application will need
to send to the peer for further processing by the init call. to send to the peer for further processing by the init call.
The "null" return value indicates that no token needs to be sent to The "null" return value indicates that no token needs to be sent to
the peer. The application can call isEstablished() to determine if the peer. The application can call isEstablished() to determine if
the context establishment phase is complete for this peer. A return the context establishment phase is complete for this peer. A return
value of "false" from isEstablished() indicates that more tokens are value of "false" from isEstablished() indicates that more tokens are
expected to be supplied to this method. expected to be supplied to this method.
Note that it is possible that acceptSecContext() will return a token Note that it is possible that acceptSecContext() will return a token
for the peer and isEstablished() will return "true" also. This for the peer and isEstablished() will return "true" also. This
indicates that the token needs to be sent to the peer, but the local indicates that the token needs to be sent to the peer, but the local
end of the context is now fully established. end of the context is now fully established.
Upon completion of the context establishment, the available context Upon completion of the context establishment, the available context
options may be queried through the get methods. options may be queried through the get methods.
A GSSException will be thrown if the call fails. Users should call A GSSException will be thrown if the call fails. Users SHOULD call
its getOutputToken() method to find out if there is a token that can its getOutputToken() method to find out if there is a token that can
be sent to the initiator to communicate the reason for the error. be sent to the initiator to communicate the reason for the error.
Parameters: Parameters:
inTok Token generated by the peer. inTok Token generated by the peer.
offset The offset within the inTok where the token offset The offset within the inTok where the token
begins. begins.
len The length of the token within the inTok len The length of the token within the inTok
(starting at the offset). (starting at the offset).
6.4.4. isEstablished 7.4.4. isEstablished
public boolean isEstablished() public boolean isEstablished()
Used during context establishment to determine the state of the Used during context establishment to determine the state of the
context. Returns "true" if this is a fully established context on context. Returns "true" if this is a fully established context on
the caller's side and no more tokens are needed from the peer. the caller's side and no more tokens are needed from the peer.
Should be called after a call to initSecContext() or Should be called after a call to initSecContext() or
acceptSecContext() when no GSSException is thrown. acceptSecContext() when no GSSException is thrown.
6.4.5. dispose 7.4.5. dispose
public void dispose() throws GSSException public void dispose() throws GSSException
Releases any system resources and cryptographic information stored in Releases any system resources and cryptographic information stored in
the context object. This will invalidate the context. the context object. This will invalidate the context.
6.4.6. getWrapSizeLimit 7.4.6. getWrapSizeLimit
public int getWrapSizeLimit(int qop, boolean confReq, public int getWrapSizeLimit(int qop, boolean confReq,
int maxTokenSize) throws GSSException int maxTokenSize) throws GSSException
Returns the maximum message size that, if presented to the wrap Returns the maximum message size that, if presented to the wrap
method with the same confReq and qop parameters, will result in an method with the same confReq and qop parameters, will result in an
output token containing no more than the maxTokenSize bytes. output token containing no more than the maxTokenSize bytes.
This call is intended for use by applications that communicate over This call is intended for use by applications that communicate over
protocols that impose a maximum message size. It enables the protocols that impose a maximum message size. It enables the
application to fragment messages prior to applying protection. application to fragment messages prior to applying protection.
GSS-API implementations are recommended but not required to detect GSS-API implementations are RECOMMENDED but not required to detect
invalid QOP values when getWrapSizeLimit is called. This routine invalid QOP values when getWrapSizeLimit is called. This routine
guarantees only a maximum message size, not the availability of guarantees only a maximum message size, not the availability of
specific QOP values for message protection. specific QOP values for message protection.
Successful completion of this call does not guarantee that wrap will Successful completion of this call does not guarantee that wrap will
be able to protect a message of the computed length, since this be able to protect a message of the computed length, since this
ability may depend on the availability of system resources at the ability may depend on the availability of system resources at the
time that wrap is called. However, if the implementation itself time that wrap is called. However, if the implementation itself
imposes an upper limit on the length of messages that may be imposes an upper limit on the length of messages that may be
processed by wrap, the implementation should not return a value that processed by wrap, the implementation SHOULD NOT return a value that
is greater than this length. is greater than this length.
Parameters: Parameters:
qop Indicates the level of protection wrap will be qop Indicates the level of protection wrap will be
asked to provide. asked to provide.
confReq Indicates if wrap will be asked to provide confReq Indicates if wrap will be asked to provide
privacy service. privacy service.
maxTokenSize The desired maximum size of the token emitted by maxTokenSize The desired maximum size of the token emitted by
wrap. wrap.
6.4.7. wrap 7.4.7. wrap
public byte[] wrap(byte[] inBuf, int offset, int len, public byte[] wrap(byte[] inBuf, int offset, int len,
MessageProp msgProp) throws GSSException MessageProp msgProp) throws GSSException
Applies per-message security services over the established security Applies per-message security services over the established security
context. The method will return a token with a cryptographic MIC and context. The method will return a token with a cryptographic MIC and
may optionally encrypt the specified inBuf. The returned byte array MAY optionally encrypt the specified inBuf. The returned byte array
will contain both the MIC and the message. will contain both the MIC and the message.
The MessageProp object is instantiated by the application and used to The MessageProp object is instantiated by the application and used to
specify a QOP value that selects cryptographic algorithms, and a specify a QOP value that selects cryptographic algorithms, and a
privacy service to optionally encrypt the message. The underlying privacy service to optionally encrypt the message. The underlying
mechanism that is used in the call may not be able to provide the mechanism that is used in the call may not be able to provide the
privacy service. It sets the actual privacy service that it does privacy service. It sets the actual privacy service that it does
provide in this MessageProp object, which the caller should then provide in this MessageProp object, which the caller SHOULD then
query upon return. If the mechanism is not able to provide the query upon return. If the mechanism is not able to provide the
requested QOP, it throws a GSSException with the BAD_QOP code. requested QOP, it throws a GSSException with the BAD_QOP code.
Since some application-level protocols may wish to use tokens emitted Since some application-level protocols may wish to use tokens emitted
by wrap to provide "secure framing", implementations should support by wrap to provide "secure framing", implementations SHOULD support
the wrapping of zero-length messages. the wrapping of zero-length messages.
The application will be responsible for sending the token to the The application will be responsible for sending the token to the
peer. peer.
Parameters: Parameters:
inBuf Application data to be protected. inBuf Application data to be protected.
offset The offset within the inBuf where the data offset The offset within the inBuf where the data
skipping to change at page 59, line 19 skipping to change at page 59, line 19
at the offset). at the offset).
msgProp Instance of MessageProp that is used by the msgProp Instance of MessageProp that is used by the
application to set the desired QOP and privacy application to set the desired QOP and privacy
state. Set the desired QOP to 0 to request the state. Set the desired QOP to 0 to request the
default QOP. Upon return from this method, this default QOP. Upon return from this method, this
object will contain the actual privacy state that object will contain the actual privacy state that
was applied to the message by the underlying was applied to the message by the underlying
mechanism. mechanism.
6.4.8. unwrap 7.4.8. unwrap
public byte[] unwrap(byte[] inBuf, int offset, int len, public byte[] unwrap(byte[] inBuf, int offset, int len,
MessageProp msgProp) throws GSSException MessageProp msgProp) throws GSSException
Used by the peer application to process tokens generated with the Used by the peer application to process tokens generated with the
wrap call. The method will return the message supplied in the peer wrap call. The method will return the message supplied in the peer
application to the wrap call, verifying the embedded MIC. application to the wrap call, verifying the embedded MIC.
The MessageProp object is instantiated by the application and is used The MessageProp object is instantiated by the application and is used
by the underlying mechanism to return information to the caller such by the underlying mechanism to return information to the caller such
as the QOP, whether confidentiality was applied to the message, and as the QOP, whether confidentiality was applied to the message, and
other supplementary message state information. other supplementary message state information.
Since some application-level protocols may wish to use tokens emitted Since some application-level protocols may wish to use tokens emitted
by wrap to provide "secure framing", implementations should support by wrap to provide "secure framing", implementations SHOULD support
the wrapping and unwrapping of zero-length messages. the wrapping and unwrapping of zero-length messages.
Parameters: Parameters:
inBuf GSS-API wrap token received from peer. inBuf GSS-API wrap token received from peer.
offset The offset within the inBuf where the token offset The offset within the inBuf where the token
begins. begins.
len The length of the token within the inBuf len The length of the token within the inBuf
(starting at the offset). (starting at the offset).
msgProp Upon return from the method, this object will msgProp Upon return from the method, this object will
contain the applied QOP, the privacy state of the contain the applied QOP, the privacy state of the
message, and supplementary information, described message, and supplementary information, described
in section 4.12.3, stating whether the token was in section 5.12.3, stating whether the token was
a duplicate, old, out of sequence, or arriving a duplicate, old, out of sequence, or arriving
after a gap. after a gap.
6.4.9. getMIC 7.4.9. getMIC
public byte[] getMIC(byte[] inMsg, int offset, int len, public byte[] getMIC(byte[] inMsg, int offset, int len,
MessageProp msgProp) throws GSSException MessageProp msgProp) throws GSSException
Returns a token containing a cryptographic MIC for the supplied Returns a token containing a cryptographic MIC for the supplied
message for transfer to the peer application. Unlike wrap, which message for transfer to the peer application. Unlike wrap, which
encapsulates the user message in the returned token, only the message encapsulates the user message in the returned token, only the message
MIC is returned in the output token. MIC is returned in the output token.
Note that privacy can only be applied through the wrap call. Note that privacy can only be applied through the wrap call.
Since some application-level protocols may wish to use tokens emitted Since some application-level protocols may wish to use tokens emitted
by getMIC to provide "secure framing", implementations should support by getMIC to provide "secure framing", implementations SHOULD support
derivation of MICs from zero-length messages. derivation of MICs from zero-length messages.
Parameters: Parameters:
inMsg Message over which to generate MIC. inMsg Message over which to generate MIC.
offset The offset within the inMsg where the token offset The offset within the inMsg where the token
begins. begins.
len The length of the token within the inMsg len The length of the token within the inMsg
(starting at the offset). (starting at the offset).
msgProp Instance of MessageProp that is used by the msgProp Instance of MessageProp that is used by the
application to set the desired QOP. Set the application to set the desired QOP. Set the
desired QOP to 0 in msgProp to request the desired QOP to 0 in msgProp to request the
default QOP. Alternatively, pass in "null" for default QOP. Alternatively, pass in "null" for
msgProp to request default QOP. msgProp to request default QOP.
6.4.10. verifyMIC 7.4.10. verifyMIC
public void verifyMIC(byte[] inTok, int tokOffset, int tokLen, public void verifyMIC(byte[] inTok, int tokOffset, int tokLen,
byte[] inMsg, int msgOffset, int msgLen, byte[] inMsg, int msgOffset, int msgLen,
MessageProp msgProp) throws GSSException MessageProp msgProp) throws GSSException
Verifies the cryptographic MIC, contained in the token parameter, Verifies the cryptographic MIC, contained in the token parameter,
over the supplied message. over the supplied message.
The MessageProp object is instantiated by the application and is used The MessageProp object is instantiated by the application and is used
by the underlying mechanism to return information to the caller such by the underlying mechanism to return information to the caller such
as the QOP indicating the strength of protection that was applied to as the QOP indicating the strength of protection that was applied to
the message and other supplementary message state information. the message and other supplementary message state information.
Since some application-level protocols may wish to use tokens emitted Since some application-level protocols may wish to use tokens emitted
by getMIC to provide "secure framing", implementations should support by getMIC to provide "secure framing", implementations SHOULD support
the calculation and verification of MICs over zero-length messages. the calculation and verification of MICs over zero-length messages.
Parameters: Parameters:
inTok Token generated by peer's getMIC method. inTok Token generated by peer's getMIC method.
tokOffset The offset within the inTok where the token tokOffset The offset within the inTok where the token
begins. begins.
tokLen The length of the token within the inTok tokLen The length of the token within the inTok
skipping to change at page 61, line 30 skipping to change at page 61, line 30
cryptographic MIC. cryptographic MIC.
msgOffset The offset within the inMsg where the message msgOffset The offset within the inMsg where the message
begins. begins.
msgLen The length of the message within the inMsg msgLen The length of the message within the inMsg
(starting at the offset). (starting at the offset).
msgProp Upon return from the method, this object will msgProp Upon return from the method, this object will
contain the applied QOP and supplementary contain the applied QOP and supplementary
information, described in section 4.12.3, stating information, described in section 5.12.3, stating
whether the token was a duplicate, old, out of whether the token was a duplicate, old, out of
sequence, or arriving after a gap. The sequence, or arriving after a gap. The
confidentiality state will be set to "false". confidentiality state will be set to "false".
6.4.11. export 7.4.11. export
public byte[] export() throws GSSException public byte[] export() throws GSSException
Provided to support the sharing of work between multiple processes. Provided to support the sharing of work between multiple processes.
This routine will typically be used by the context acceptor, in an This routine will typically be used by the context acceptor, in an
application where a single process receives incoming connection application where a single process receives incoming connection
requests and accepts security contexts over them, then passes the requests and accepts security contexts over them, then passes the
established context to one or more other processes for message established context to one or more other processes for message
exchange. exchange.
This method deactivates the security context and creates an inter- This method deactivates the security context and creates an inter-
process token which, when passed to the byte array constructor of the process token which, when passed to the byte array constructor of the
GSSContext interface in another process, will re-activate the context GSSContext interface in another process, will re-activate the context
in the second process. Only a single instantiation of a given in the second process. Only a single instantiation of a given
context may be active at any one time; a subsequent attempt by a context may be active at any one time; a subsequent attempt by a
context exporter to access the exported security context will fail. context exporter to access the exported security context will fail.
The implementation may constrain the set of processes by which the The implementation MAY constrain the set of processes by which the
inter-process token may be imported, either as a function of local inter-process token may be imported, either as a function of local
security policy, or as a result of implementation decisions. For security policy, or as a result of implementation decisions. For
example, some implementations may constrain contexts to be passed example, some implementations may constrain contexts to be passed
only between processes that run under the same account, or which are only between processes that run under the same account, or which are
part of the same process group. part of the same process group.
The inter-process token may contain security-sensitive information The inter-process token MAY contain security-sensitive information
(for example, cryptographic keys). While mechanisms are encouraged (for example, cryptographic keys). While mechanisms are encouraged
to either avoid placing such sensitive information within inter- to either avoid placing such sensitive information within inter-
process tokens or to encrypt the token before returning it to the process tokens or to encrypt the token before returning it to the
application, in a typical GSS-API implementation, this may not be application, in a typical GSS-API implementation, this may not be
possible. Thus, the application must take care to protect the inter- possible. Thus, the application MUST take care to protect the inter-
process token, and ensure that any process to which the token is process token, and ensure that any process to which the token is
transferred is trustworthy. transferred is trustworthy.
6.4.12. requestMutualAuth 7.4.12. requestMutualAuth
public void requestMutualAuth(boolean state) throws GSSException public void requestMutualAuth(boolean state) throws GSSException
Sets the request state of the mutual authentication flag for the Sets the request state of the mutual authentication flag for the
context. This method is only valid before the context creation context. This method is only valid before the context creation
process begins and only for the initiator. process begins and only for the initiator.
Parameters: Parameters:
state Boolean representing if mutual authentication state Boolean representing if mutual authentication
should be requested during context establishment. should be requested during context establishment.
6.4.13. requestReplayDet 7.4.13. requestReplayDet
public void requestReplayDet(boolean state) throws GSSException public void requestReplayDet(boolean state) throws GSSException
Sets the request state of the replay detection service for the Sets the request state of the replay detection service for the
context. This method is only valid before the context creation context. This method is only valid before the context creation
process begins and only for the initiator. process begins and only for the initiator.
Parameters: Parameters:
state Boolean representing if replay detection is state Boolean representing if replay detection is
desired over the established context. desired over the established context.
6.4.14. requestSequenceDet 7.4.14. requestSequenceDet
public void requestSequenceDet(boolean state) throws GSSException public void requestSequenceDet(boolean state) throws GSSException
Sets the request state for the sequence checking service of the Sets the request state for the sequence checking service of the
context. This method is only valid before the context creation context. This method is only valid before the context creation
process begins and only for the initiator. process begins and only for the initiator.
Parameters: Parameters:
state Boolean representing if sequence detection is state Boolean representing if sequence detection is
desired over the established context. desired over the established context.
6.4.15. requestCredDeleg 7.4.15. requestCredDeleg
public void requestCredDeleg(boolean state) throws GSSException public void requestCredDeleg(boolean state) throws GSSException
Sets the request state for the credential delegation flag for the Sets the request state for the credential delegation flag for the
context. This method is only valid before the context creation context. This method is only valid before the context creation
process begins and only for the initiator. process begins and only for the initiator.
Parameters: Parameters:
state Boolean representing if credential delegation is state Boolean representing if credential delegation is
desired. desired.
6.4.16. requestAnonymity 7.4.16. requestAnonymity
public void requestAnonymity(boolean state) throws GSSException public void requestAnonymity(boolean state) throws GSSException
Requests anonymous support over the context. This method is only Requests anonymous support over the context. This method is only
valid before the context creation process begins and only for the valid before the context creation process begins and only for the
initiator. initiator.
Parameters: Parameters:
state Boolean representing if anonymity support is state Boolean representing if anonymity support is
requested. requested.
6.4.17. requestConf 7.4.17. requestConf
public void requestConf(boolean state) throws GSSException public void requestConf(boolean state) throws GSSException
Requests that confidentiality service be available over the context. Requests that confidentiality service be available over the context.
This method is only valid before the context creation process begins This method is only valid before the context creation process begins
and only for the initiator. and only for the initiator.
Parameters: Parameters:
state Boolean indicating if confidentiality services state Boolean indicating if confidentiality services
are to be requested for the context. are to be requested for the context.
6.4.18. requestInteg 7.4.18. requestInteg
public void requestInteg(boolean state) throws GSSException public void requestInteg(boolean state) throws GSSException
Requests that integrity services be available over the context. This Requests that integrity services be available over the context. This
method is only valid before the context creation process begins and method is only valid before the context creation process begins and
only for the initiator. only for the initiator.
Parameters: Parameters:
state Boolean indicating if integrity services are to state Boolean indicating if integrity services are to
be requested for the context. be requested for the context.
6.4.19. requestLifetime 7.4.19. requestLifetime
public void requestLifetime(int lifetime) throws GSSException public void requestLifetime(int lifetime) throws GSSException
Sets the desired lifetime for the context in seconds. This method is Sets the desired lifetime for the context in seconds. This method is
only valid before the context creation process begins and only for only valid before the context creation process begins and only for
the initiator. Use GSSContext.INDEFINITE_LIFETIME and the initiator. Use GSSContext.INDEFINITE_LIFETIME and
GSSContext.DEFAULT_LIFETIME to request indefinite or default context GSSContext.DEFAULT_LIFETIME to request indefinite or default context
lifetime. lifetime.
Parameters: Parameters:
lifetime The desired context lifetime in seconds. lifetime The desired context lifetime in seconds.
6.4.20. setChannelBinding 7.4.20. setChannelBinding
public void setChannelBinding(ChannelBinding cb) throws GSSException public void setChannelBinding(ChannelBinding cb) throws GSSException
Sets the channel bindings to be used during context establishment. Sets the channel bindings to be used during context establishment.
This method is only valid before the context creation process begins. This method is only valid before the context creation process begins.
Parameters: Parameters:
cb Channel bindings to be used. cb Channel bindings to be used.
6.4.21. getCredDelegState 7.4.21. getCredDelegState
public boolean getCredDelegState() public boolean getCredDelegState()
Returns the state of the delegated credentials for the context. When Returns the state of the delegated credentials for the context. When
issued before context establishment is completed or when the issued before context establishment is completed or when the
isProtReady method returns "false", it returns the desired state; isProtReady method returns "false", it returns the desired state;
otherwise, it will indicate the actual state over the established otherwise, it will indicate the actual state over the established
context. context.
6.4.22. getMutualAuthState 7.4.22. getMutualAuthState
public boolean getMutualAuthState() public boolean getMutualAuthState()
Returns the state of the mutual authentication option for the Returns the state of the mutual authentication option for the
context. When issued before context establishment completes or when context. When issued before context establishment completes or when
the isProtReady method returns "false", it returns the desired state; the isProtReady method returns "false", it returns the desired state;
otherwise, it will indicate the actual state over the established otherwise, it will indicate the actual state over the established
context. context.
6.4.23. getReplayDetState 7.4.23. getReplayDetState
public boolean getReplayDetState() public boolean getReplayDetState()
Returns the state of the replay detection option for the context. Returns the state of the replay detection option for the context.
When issued before context establishment completes or when the When issued before context establishment completes or when the
isProtReady method returns "false", it returns the desired state; isProtReady method returns "false", it returns the desired state;
otherwise, it will indicate the actual state over the established otherwise, it will indicate the actual state over the established
context. context.
6.4.24. getSequenceDetState 7.4.24. getSequenceDetState
public boolean getSequenceDetState() public boolean getSequenceDetState()
Returns the state of the sequence detection option for the context. Returns the state of the sequence detection option for the context.
When issued before context establishment completes or when the When issued before context establishment completes or when the
isProtReady method returns "false", it returns the desired state; isProtReady method returns "false", it returns the desired state;
otherwise, it will indicate the actual state over the established otherwise, it will indicate the actual state over the established
context. context.
6.4.25. getAnonymityState 7.4.25. getAnonymityState
public boolean getAnonymityState() public boolean getAnonymityState()
Returns "true" if this is an anonymous context. When issued before Returns "true" if this is an anonymous context. When issued before
context establishment completes or when the isProtReady method context establishment completes or when the isProtReady method
returns "false", it returns the desired state; otherwise, it will returns "false", it returns the desired state; otherwise, it will
indicate the actual state over the established context. indicate the actual state over the established context.
6.4.26. isTransferable 7.4.26. isTransferable
public boolean isTransferable() throws GSSException public boolean isTransferable() throws GSSException
Returns "true" if the context is transferable to other processes Returns "true" if the context is transferable to other processes
through the use of the export method. This call is only valid on through the use of the export method. This call is only valid on
fully established contexts. fully established contexts.
6.4.27. isProtReady 7.4.27. isProtReady
public boolean isProtReady() public boolean isProtReady()
Returns "true" if the per-message operations can be applied over the Returns "true" if the per-message operations can be applied over the
context. Some mechanisms may allow the usage of per-message context. Some mechanisms may allow the usage of per-message
operations before the context is fully established. This will also operations before the context is fully established. This will also
indicate that the get methods will return actual context state indicate that the get methods will return actual context state
characteristics instead of the desired ones. characteristics instead of the desired ones.
6.4.28. getConfState 7.4.28. getConfState
public boolean getConfState() public boolean getConfState()
Returns the confidentiality service state over the context. When Returns the confidentiality service state over the context. When
issued before context establishment completes or when the isProtReady issued before context establishment completes or when the isProtReady
method returns "false", it returns the desired state; otherwise, it method returns "false", it returns the desired state; otherwise, it
will indicate the actual state over the established context. will indicate the actual state over the established context.
6.4.29. getIntegState 7.4.29. getIntegState
public boolean getIntegState() public boolean getIntegState()
Returns the integrity service state over the context. When issued Returns the integrity service state over the context. When issued
before context establishment completes or when the isProtReady method before context establishment completes or when the isProtReady method
returns "false", it returns the desired state; otherwise, it will returns "false", it returns the desired state; otherwise, it will
indicate the actual state over the established context. indicate the actual state over the established context.
6.4.30. getLifetime 7.4.30. getLifetime
public int getLifetime() public int getLifetime()
Returns the context lifetime in seconds. When issued before context Returns the context lifetime in seconds. When issued before context
establishment completes or when the isProtReady method returns establishment completes or when the isProtReady method returns
"false", it returns the desired lifetime; otherwise, it will indicate "false", it returns the desired lifetime; otherwise, it will indicate
the remaining lifetime for the context. the remaining lifetime for the context.
6.4.31. getSrcName 7.4.31. getSrcName
public GSSName getSrcName() throws GSSException public GSSName getSrcName() throws GSSException
Returns the name of the context initiator. This call is valid only Returns the name of the context initiator. This call is valid only
after the context is fully established or the isProtReady method after the context is fully established or the isProtReady method
returns "true". It is guaranteed to return an MN. returns "true". It is guaranteed to return an MN.
6.4.32. getTargName 7.4.32. getTargName
public GSSName getTargName() throws GSSException public GSSName getTargName() throws GSSException
Returns the name of the context target (acceptor). This call is Returns the name of the context target (acceptor). This call is
valid only after the context is fully established or the isProtReady valid only after the context is fully established or the isProtReady
method returns "true". It is guaranteed to return an MN. method returns "true". It is guaranteed to return an MN.
6.4.33. getMech 7.4.33. getMech
public Oid getMech() throws GSSException public Oid getMech() throws GSSException
Returns the mechanism oid for this context. This method may be Returns the mechanism oid for this context. This method MAY be
called before the context is fully established, but the mechanism called before the context is fully established, but the mechanism
returned may change on successive calls in negotiated mechanism case. returned MAY change on successive calls in negotiated mechanism case.
6.4.34. getDelegCred 7.4.34. getDelegCred
public GSSCredential getDelegCred() throws GSSException public GSSCredential getDelegCred() throws GSSException
Returns the delegated credential object on the acceptor's side. To Returns the delegated credential object on the acceptor's side. To
check for availability of delegated credentials call check for availability of delegated credentials call
getDelegCredState. This call is only valid on fully established getDelegCredState. This call is only valid on fully established
contexts. contexts.
6.4.35. isInitiator 7.4.35. isInitiator
public boolean isInitiator() throws GSSException public boolean isInitiator() throws GSSException
Returns "true" if this is the initiator of the context. This call is Returns "true" if this is the initiator of the context. This call is
only valid after the context creation process has started. only valid after the context creation process has started.
6.4.36. Example Code 7.4.36. Example Code
The example code presented below demonstrates the usage of the The example code presented below demonstrates the usage of the
GSSContext interface for the initiating peer. Different operations GSSContext interface for the initiating peer. Different operations
on the GSSContext object are presented, including: object on the GSSContext object are presented, including: object
instantiation, setting of desired flags, context establishment, query instantiation, setting of desired flags, context establishment, query
of actual context flags, per-message operations on application data, of actual context flags, per-message operations on application data,
and finally context deletion. and finally context deletion.
<CODE BEGINS> <CODE BEGINS>
GSSManager mgr = GSSManager.getInstance(); GSSManager mgr = GSSManager.getInstance();
skipping to change at page 69, line 31 skipping to change at page 69, line 31
if (mProp.getPrivacy()) if (mProp.getPrivacy())
print("Message protected with privacy."); print("Message protected with privacy.");
sendToken(tok); sendToken(tok);
// release the local end of the context // release the local end of the context
context.dispose(); context.dispose();
<CODE ENDS> <CODE ENDS>
6.5. public class MessageProp 7.5. public class MessageProp
This is a utility class used within the per-message GSSContext This is a utility class used within the per-message GSSContext
methods to convey per-message properties. methods to convey per-message properties.
When used with the GSSContext interface's wrap and getMIC methods, an When used with the GSSContext interface's wrap and getMIC methods, an
instance of this class is used to indicate the desired QOP and to instance of this class is used to indicate the desired QOP and to
request if confidentiality services are to be applied to caller request if confidentiality services are to be applied to caller
supplied data (wrap only). To request default QOP, the value of 0 supplied data (wrap only). To request default QOP, the value of 0
should be used for QOP. A QOP is an integer value defined by an should be used for QOP. A QOP is an integer value defined by an
mechanism. mechanism.
When used with the unwrap and verifyMIC methods of the GSSContext When used with the unwrap and verifyMIC methods of the GSSContext
interface, an instance of this class will be used to indicate the interface, an instance of this class will be used to indicate the
applied QOP and confidentiality services over the supplied message. applied QOP and confidentiality services over the supplied message.
In the case of verifyMIC, the confidentiality state will always be In the case of verifyMIC, the confidentiality state will always be
"false". Upon return from these methods, this object will also "false". Upon return from these methods, this object will also
contain any supplementary status values applicable to the processed contain any supplementary status values applicable to the processed
token. The supplementary status values can indicate old tokens, out token. The supplementary status values can indicate old tokens, out
of sequence tokens, gap tokens, or duplicate tokens. of sequence tokens, gap tokens, or duplicate tokens.
6.5.1. Constructors 7.5.1. Constructors
public MessageProp(boolean privState) public MessageProp(boolean privState)
Constructor that sets QOP to 0 indicating that the default QOP is Constructor that sets QOP to 0 indicating that the default QOP is
requested. requested.
Parameters: Parameters:
privState The desired privacy state. "true" for privacy and privState The desired privacy state. "true" for privacy and
"false" for integrity only. "false" for integrity only.
skipping to change at page 70, line 28 skipping to change at page 70, line 28
Constructor that sets the values for the qop and privacy state. Constructor that sets the values for the qop and privacy state.
Parameters: Parameters:
qop The desired QOP. Use 0 to request a default QOP. qop The desired QOP. Use 0 to request a default QOP.
privState The desired privacy state. "true" for privacy and privState The desired privacy state. "true" for privacy and
"false" for integrity only. "false" for integrity only.
6.5.2. getQOP 7.5.2. getQOP
public int getQOP() public int getQOP()
Retrieves the QOP value. Retrieves the QOP value.
6.5.3. getPrivacy 7.5.3. getPrivacy
public boolean getPrivacy() public boolean getPrivacy()
Retrieves the privacy state. Retrieves the privacy state.
6.5.4. getMinorStatus 7.5.4. getMinorStatus
public int getMinorStatus() public int getMinorStatus()
Retrieves the minor status that the underlying mechanism might have Retrieves the minor status that the underlying mechanism might have
set. set.
6.5.5. getMinorString 7.5.5. getMinorString
public String getMinorString() public String getMinorString()
Returns a string explaining the mechanism-specific error code. "null" Returns a string explaining the mechanism-specific error code. "null"
will be returned when no mechanism error code has been set. will be returned when no mechanism error code has been set.
6.5.6. setQOP 7.5.6. setQOP
public void setQOP(int qopVal) public void setQOP(int qopVal)
Sets the QOP value. Sets the QOP value.
Parameters: Parameters:
qopVal The QOP value to be set. Use 0 to request a qopVal The QOP value to be set. Use 0 to request a
default QOP value. default QOP value.
6.5.7. setPrivacy 7.5.7. setPrivacy
public void setPrivacy(boolean privState) public void setPrivacy(boolean privState)
Sets the privacy state. Sets the privacy state.
Parameters: Parameters:
privState The privacy state to set. privState The privacy state to set.
6.5.8. isDuplicateToken 7.5.8. isDuplicateToken
public boolean isDuplicateToken() public boolean isDuplicateToken()
Returns "true" if this is a duplicate of an earlier token. Returns "true" if this is a duplicate of an earlier token.
6.5.9. isOldToken 7.5.9. isOldToken
public boolean isOldToken() public boolean isOldToken()
Returns "true" if the token's validity period has expired. Returns "true" if the token's validity period has expired.
6.5.10. isUnseqToken 7.5.10. isUnseqToken
public boolean isUnseqToken() public boolean isUnseqToken()
Returns "true" if a later token has already been processed. Returns "true" if a later token has already been processed.
6.5.11. isGapToken 7.5.11. isGapToken
public boolean isGapToken() public boolean isGapToken()
Returns "true" if an expected per-message token was not received. Returns "true" if an expected per-message token was not received.
6.5.12. setSupplementaryStates 7.5.12. setSupplementaryStates
public void setSupplementaryStates(boolean duplicate, public void setSupplementaryStates(boolean duplicate,
boolean old, boolean unseq, boolean gap, boolean old, boolean unseq, boolean gap,
int minorStatus, String minorString) int minorStatus, String minorString)
This method sets the state for the supplementary information flags This method sets the state for the supplementary information flags
and the minor status in MessageProp. It is not used by the and the minor status in MessageProp. It is not used by the
application but by the GSS implementation to return this information application but by the GSS implementation to return this information
to the caller of a per-message context method. to the caller of a per-message context method.
skipping to change at page 72, line 37 skipping to change at page 72, line 37
gap "true" if one or more predecessor tokens have not gap "true" if one or more predecessor tokens have not
yet been successfully processed; otherwise, yet been successfully processed; otherwise,
"false". "false".
minorStatus The integer minor status code that the underlying minorStatus The integer minor status code that the underlying
mechanism wants to set. mechanism wants to set.
minorString The textual representation of the minorStatus minorString The textual representation of the minorStatus
value. value.
6.6. public class ChannelBinding 7.6. public class ChannelBinding
The GSS-API accommodates the concept of caller-provided channel The GSS-API accommodates the concept of caller-provided channel
binding information. Channel bindings are used to strengthen the binding information. Channel bindings are used to strengthen the
quality with which peer entity authentication is provided during quality with which peer entity authentication is provided during
context establishment. They enable the GSS-API callers to bind the context establishment. They enable the GSS-API callers to bind the
establishment of the security context to relevant characteristics establishment of the security context to relevant characteristics
like addresses or to application-specific data. like addresses or to application-specific data.
The caller initiating the security context must determine the The caller initiating the security context MUST determine the
appropriate channel binding values to set in the GSSContext object. appropriate channel binding values to set in the GSSContext object.
The acceptor must provide an identical binding in order to validate The acceptor MUST provide an identical binding in order to validate
that received tokens possess correct channel-related characteristics. that received tokens possess correct channel-related characteristics.
Use of channel bindings is optional in GSS-API. Since channel- Use of channel bindings is OPTIONAL in GSS-API. Since channel-
binding information may be transmitted in context establishment binding information may be transmitted in context establishment
tokens, applications should therefore not use confidential data as tokens, applications SHOULD therefore not use confidential data as
channel-binding components. channel-binding components.
6.6.1. Constructors 7.6.1. Constructors
public ChannelBinding(InetAddress initAddr, InetAddress acceptAddr, public ChannelBinding(InetAddress initAddr, InetAddress acceptAddr,
byte[] appData) byte[] appData)
Create a ChannelBinding object with user-supplied address information Create a ChannelBinding object with user-supplied address information
and data. "null" values can be used for any fields that the and data. "null" values can be used for any fields that the
application does not want to specify. application does not want to specify.
Parameters: Parameters:
skipping to change at page 73, line 40 skipping to change at page 73, line 40
public ChannelBinding(byte[] appData) public ChannelBinding(byte[] appData)
Creates a ChannelBinding object without any addressing information. Creates a ChannelBinding object without any addressing information.
Parameters: Parameters:
appData Application supplied data to be used as part of appData Application supplied data to be used as part of
the channel bindings. the channel bindings.
6.6.2. getInitiatorAddress 7.6.2. getInitiatorAddress
public InetAddress getInitiatorAddress() public InetAddress getInitiatorAddress()
Returns the initiator's address for this channel binding. "null" is Returns the initiator's address for this channel binding. "null" is
returned if the address has not been set. returned if the address has not been set.
6.6.3. getAcceptorAddress 7.6.3. getAcceptorAddress
public InetAddress getAcceptorAddress() public InetAddress getAcceptorAddress()
Returns the acceptor's address for this channel binding. "null" is Returns the acceptor's address for this channel binding. "null" is
returned if the address has not been set. returned if the address has not been set.
6.6.4. getApplicationData 7.6.4. getApplicationData
public byte[] getApplicationData() public byte[] getApplicationData()
Returns application data being used as part of the ChannelBinding. Returns application data being used as part of the ChannelBinding.
"null" is returned if no application data has been specified for the "null" is returned if no application data has been specified for the
channel binding. channel binding.
6.6.5. equals 7.6.5. equals
public boolean equals(Object obj) public boolean equals(Object obj)
Returns "true" if two channel bindings match. (Note that the Java Returns "true" if two channel bindings match. (Note that the Java
language specification requires that two objects that are equal language specification requires that two objects that are equal
according to the equals(Object) method must return the same integer according to the equals(Object) method MUST return the same integer
result when the hashCode() method is called on them.) result when the hashCode() method is called on them.)
Parameters: Parameters:
obj Another channel binding with which to compare. obj Another channel binding with which to compare.
6.7. public class Oid 7.7. public class Oid
This class represents Universal Object Identifiers (Oids) and their This class represents Universal Object Identifiers (Oids) and their
associated operations. associated operations.
Oids are hierarchically globally interpretable identifiers used Oids are hierarchically globally interpretable identifiers used
within the GSS-API framework to identify mechanisms and name formats. within the GSS-API framework to identify mechanisms and name formats.
The structure and encoding of Oids is defined in ISOIEC-8824 and The structure and encoding of Oids is defined in ISOIEC-8824 and
ISOIEC-8825. For example, the Oid representation of the Kerberos v5 ISOIEC-8825. For example, the Oid representation of the Kerberos v5
mechanism is "1.2.840.113554.1.2.2". mechanism is "1.2.840.113554.1.2.2".
The GSSName name class contains public static Oid objects The GSSName name class contains public static Oid objects
representing the standard name types defined in GSS-API. representing the standard name types defined in GSS-API.
6.7.1. Constructors 7.7.1. Constructors
public Oid(String strOid) throws GSSException public Oid(String strOid) throws GSSException
Creates an Oid object from a string representation of its integer Creates an Oid object from a string representation of its integer
components (e.g., "1.2.840.113554.1.2.2"). components (e.g., "1.2.840.113554.1.2.2").
Parameters: Parameters:
strOid The string representation for the oid. strOid The string representation for the oid.
skipping to change at page 75, line 29 skipping to change at page 75, line 29
Creates an Oid object from its DER encoding. This refers to the full Creates an Oid object from its DER encoding. This refers to the full
encoding including tag and length. The structure and encoding of encoding including tag and length. The structure and encoding of
Oids is defined in ISOIEC-8824 and ISOIEC-8825. This method is Oids is defined in ISOIEC-8824 and ISOIEC-8825. This method is
identical in functionality to its byte array counterpart. identical in functionality to its byte array counterpart.
Parameters: Parameters:
derOid Byte array storing a DER-encoded oid. derOid Byte array storing a DER-encoded oid.
6.7.2. toString 7.7.2. toString
public String toString() public String toString()
Returns a string representation of the oid's integer components in Returns a string representation of the oid's integer components in
dot separated notation (e.g., "1.2.840.113554.1.2.2"). dot separated notation (e.g., "1.2.840.113554.1.2.2").
6.7.3. equals 7.7.3. equals
public boolean equals(Object Obj) public boolean equals(Object Obj)
Returns "true" if the two Oid objects represent the same oid value. Returns "true" if the two Oid objects represent the same oid value.
(Note that the Java language specification [JLS] requires that two (Note that the Java language specification [JLS] requires that two
objects that are equal according to the equals(Object) method must objects that are equal according to the equals(Object) method MUST
return the same integer result when the hashCode() method is called return the same integer result when the hashCode() method is called
on them.) on them.)
Parameters: Parameters:
obj Another Oid object with which to compare. obj Another Oid object with which to compare.
6.7.4. getDER 7.7.4. getDER
public byte[] getDER() public byte[] getDER()
Returns the full ASN.1 DER encoding for this oid object, which Returns the full ASN.1 DER encoding for this oid object, which
includes the tag and length. includes the tag and length.
6.7.5. containedIn 7.7.5. containedIn
public boolean containedIn(Oid[] oids) public boolean containedIn(Oid[] oids)
A utility method to test if an Oid object is contained within the A utility method to test if an Oid object is contained within the
supplied Oid object array. supplied Oid object array.
Parameters: Parameters:
oids An array of oids to search. oids An array of oids to search.
6.8. public class GSSException extends Exception 7.8. public class GSSException extends Exception
This exception is thrown whenever a fatal GSS-API error occurs This exception is thrown whenever a fatal GSS-API error occurs
including mechanism-specific errors. It may contain both, the major including mechanism-specific errors. It MAY contain both, the major
and minor, GSS-API status codes. The mechanism implementors are and minor, GSS-API status codes. The mechanism implementors are
responsible for setting appropriate minor status codes when throwing responsible for setting appropriate minor status codes when throwing
this exception. Aside from delivering the numeric error code(s) to this exception. Aside from delivering the numeric error code(s) to
the caller, this class performs the mapping from their numeric values the caller, this class performs the mapping from their numeric values
to textual representations. This exception may also include an to textual representations. This exception MAY also include an
output token that should be sent to the peer. For example, when an output token that SHOULD be sent to the peer. For example, when an
initSecContext call fails due to a fatal error, the mechanism may initSecContext call fails due to a fatal error, the mechanism MAY
define an error token that should be sent to the peer for debugging define an error token that SHOULD be sent to the peer for debugging
or informational purpose. All Java GSS-API methods are declared or informational purpose. All Java GSS-API methods are declared
throwing this exception. throwing this exception.
All implementations are encouraged to use the Java All implementations are encouraged to use the Java
internationalization techniques to provide local translations of the internationalization techniques to provide local translations of the
message strings. message strings.
6.8.1. Static Constants 7.8.1. Static Constants
All valid major GSS-API error code values are declared as constants All valid major GSS-API error code values are declared as constants
in this class. in this class.
public static final int BAD_BINDINGS public static final int BAD_BINDINGS
Channel bindings mismatch error. The value of this constant is 1. Channel bindings mismatch error. The value of this constant is 1.
public static final int BAD_MECH public static final int BAD_MECH
Unsupported mechanism requested error. The value of this constant is Unsupported mechanism requested error. The value of this constant is
skipping to change at page 79, line 15 skipping to change at page 79, line 15
constant is 21. constant is 21.
public static final int GAP_TOKEN public static final int GAP_TOKEN
An expected per-message token was not received. This is contained in An expected per-message token was not received. This is contained in
an exception only when detected during context establishment, in an exception only when detected during context establishment, in
which case it is considered a fatal error. (Non-fatal supplementary which case it is considered a fatal error. (Non-fatal supplementary
codes are indicated via the MessageProp object.) The value of this codes are indicated via the MessageProp object.) The value of this
constant is 22. constant is 22.
6.8.2. Constructors 7.8.2. Constructors
public GSSException(int majorCode) public GSSException(int majorCode)
Creates a GSSException object with a specified major code. Creates a GSSException object with a specified major code.
Calling this constructor is equivalent to calling Calling this constructor is equivalent to calling
GSSException(majorCode, null, 0, null, null). GSSException(majorCode, null, 0, null, null).
public GSSException(int majorCode, int minorCode, String minorString) public GSSException(int majorCode, int minorCode, String minorString)
skipping to change at page 80, line 13 skipping to change at page 80, line 13
matches the majorCode will be set. matches the majorCode will be set.
minorCode The mechanism error code causing this exception minorCode The mechanism error code causing this exception
to be thrown. Can be 0 if no mechanism error to be thrown. Can be 0 if no mechanism error
code is available. code is available.
minorString The textual explanation of the mechanism error minorString The textual explanation of the mechanism error
code. Can be null if no textual explanation is code. Can be null if no textual explanation is
available. available.
outputToken The output token that should be sent to the peer. outputToken The output token that SHOULD be sent to the peer.
Can be null if no such token is available. It Can be null if no such token is available. It
must not be an empty array. When provided, the MUST NOT be an empty array. When provided, the
array will be cloned to protect against array will be cloned to protect against
subsequent modifications. subsequent modifications.
6.8.3. getMajor 7.8.3. getMajor
public int getMajor() public int getMajor()
Returns the major code representing the GSS error code that caused Returns the major code representing the GSS error code that caused
this exception to be thrown. this exception to be thrown.
6.8.4. getMinor 7.8.4. getMinor
public int getMinor() public int getMinor()
Returns the mechanism error code that caused this exception. The Returns the mechanism error code that caused this exception. The
minor code is set by the underlying mechanism. Value of 0 indicates minor code is set by the underlying mechanism. Value of 0 indicates
that mechanism error code is not set. that mechanism error code is not set.
6.8.5. getMajorString 7.8.5. getMajorString
public String getMajorString() public String getMajorString()
Returns a string explaining the GSS major error code causing this Returns a string explaining the GSS major error code causing this
exception to be thrown. exception to be thrown.
6.8.6. getMinorString 7.8.6. getMinorString
public String getMinorString() public String getMinorString()
Returns a string explaining the mechanism-specific error code. "null" Returns a string explaining the mechanism-specific error code. "null"
will be returned when no string explaining the mechanism error code will be returned when no string explaining the mechanism error code
has been set. has been set.
6.8.7. getOutputToken 7.8.7. getOutputToken
public byte[] getOutputToken public byte[] getOutputToken
Returns the output token in a new byte array. Returns the output token in a new byte array.
If the method (For example, GSSContext#initSecContext) that throws If the method (For example, GSSContext#initSecContext) that throws
this GSSException needs to generate an output token that should be this GSSException needs to generate an output token that SHOULD be
sent to the peer, that token will be stored in this GSSException and sent to the peer, that token will be stored in this GSSException and
can be retrieved with this method. can be retrieved with this method.
The return value must be null if no such token is generated. It must The return value MUST be null if no such token is generated. It MUST
not be an empty byte array. NOT be an empty byte array.
6.8.8. setMinor 7.8.8. setMinor
public void setMinor(int minorCode, String message) public void setMinor(int minorCode, String message)
Used internally by the GSS-API implementation and the underlying Used internally by the GSS-API implementation and the underlying
mechanisms to set the minor code and its textual representation. mechanisms to set the minor code and its textual representation.
Parameters: Parameters:
minorCode The mechanism-specific error code. minorCode The mechanism-specific error code.
message A textual explanation of the mechanism error message A textual explanation of the mechanism error
code. code.
6.8.9. toString 7.8.9. toString
public String toString() public String toString()
Returns a textual representation of both the major and minor status Returns a textual representation of both the major and minor status
codes. codes.
6.8.10. getMessage 7.8.10. getMessage
public String getMessage() public String getMessage()
Returns a detailed message of this exception. Overrides Returns a detailed message of this exception. Overrides
Throwable.getMessage. It is customary in Java to use this method to Throwable.getMessage. It is customary in Java to use this method to
obtain exception information. obtain exception information.
7. Sample Applications 8. Sample Applications
7.1. Simple GSS Context Initiator 8.1. Simple GSS Context Initiator
<CODE BEGINS> <CODE BEGINS>
import org.ietf.jgss.*; import org.ietf.jgss.*;
/** /**
* This is a partial sketch for a simple client program that acts * This is a partial sketch for a simple client program that acts
* as a GSS context initiator. It illustrates how to use the Java * as a GSS context initiator. It illustrates how to use the Java
* bindings for the GSS-API specified in * bindings for the GSS-API specified in
* Generic Security Service API Version 2 : Java bindings * Generic Security Service API Version 2 : Java bindings
* *
skipping to change at page 85, line 45 skipping to change at page 85, line 45
... ...
... ...
} // end of doCommunication method } // end of doCommunication method
... ...
... ...
} // end of class SimpleClient } // end of class SimpleClient
<CODE ENDS> <CODE ENDS>
7.2. Simple GSS Context Acceptor 8.2. Simple GSS Context Acceptor
<CODE BEGINS> <CODE BEGINS>
import org.ietf.jgss.*; import org.ietf.jgss.*;
/** /**
* This is a partial sketch for a simple server program that acts * This is a partial sketch for a simple server program that acts
* as a GSS context acceptor. It illustrates how to use the Java * as a GSS context acceptor. It illustrates how to use the Java
* bindings for the GSS-API specified in * bindings for the GSS-API specified in
* Generic Security Service API Version 2 : Java bindings. * Generic Security Service API Version 2 : Java bindings.
* *
skipping to change at page 89, line 34 skipping to change at page 89, line 34
} // end of run method in ServerThread } // end of run method in ServerThread
} // end of inner class ServerThread } // end of inner class ServerThread
... ...
... ...
} // end of class SimpleServer } // end of class SimpleServer
<CODE ENDS> <CODE ENDS>
8. Security Considerations 9. Security Considerations
The Java language security model allows platform providers to have The Java language security model allows platform providers to have
policy-based fine-grained access control over any resource that an policy-based fine-grained access control over any resource that an
application wants. When using a Java security manager (such as, but application wants. When using a Java security manager (such as, but
not limited to, the case of applets running in browsers) the not limited to, the case of applets running in browsers) the
application code is in a sandbox by default. application code is in a sandbox by default.
Administrators of the platform JRE determine what permissions, if Administrators of the platform JRE determine what permissions, if
any, are to be given to source from different codebases. Thus, the any, are to be given to source from different codebases. Thus, the
administrator has to be aware of any special requirements that the administrator has to be aware of any special requirements that the
skipping to change at page 90, line 28 skipping to change at page 90, line 28
java.security.Security class and then depend on the system to find java.security.Security class and then depend on the system to find
the right provider automatically when the need arises. (This the right provider automatically when the need arises. (This
would require the application to be granted a "insertProvider would require the application to be granted a "insertProvider
SecurityPermission".) SecurityPermission".)
2) To pass an instance of the provider to the local instance of 2) To pass an instance of the provider to the local instance of
GSSManager so that only factory calls going through that GSSManager so that only factory calls going through that
GSSManager use the desired provider. (This would not require any GSSManager use the desired provider. (This would not require any
permissions.) permissions.)
9. IANA Considerations 10. IANA Considerations
This document has no actions for IANA. This document has no actions for IANA.
10. Acknowledgments 11. Acknowledgments
This proposed API leverages earlier work performed by the IETF's CAT This proposed API leverages earlier work performed by the IETF's CAT
WG as outlined in both RFC 2743 [RFC2743] and RFC 2744 [RFC2744]. WG as outlined in both RFC 2743 [RFC2743] and RFC 2744 [RFC2744].
Many conceptual definitions, implementation directions, and Many conceptual definitions, implementation directions, and
explanations have been included from these documents. explanations have been included from these documents.
We would like to thank Mike Eisler, Lin Ling, Ram Marti, Michael We would like to thank Mike Eisler, Lin Ling, Ram Marti, Michael
Saltz, and other members of Sun's development team for their helpful Saltz, and other members of Sun's development team for their helpful
input, comments, and suggestions. input, comments, and suggestions.
We would also like to thank Joe Salowey, and Michael Smith for many We would also like to thank Joe Salowey, and Michael Smith for many
insightful ideas and suggestions that have contributed to this insightful ideas and suggestions that have contributed to this
document. document.
11. Changes since RFC 5653 12. Changes since RFC 5653
This document has following changes: This document has following changes:
1) New error token embedded in GSSException 1) New error token embedded in GSSException
There is a design flaw in the initSecContext and acceptSecContext There is a design flaw in the initSecContext and acceptSecContext
methods of the GSSContext class defined in Generic Security methods of the GSSContext class defined in Generic Security
Service API Version 2: Java Bindings Update [RFC5653]. Service API Version 2: Java Bindings Update [RFC5653].
The methods could either return a token (possibly null if no more The methods could either return a token (possibly null if no more
tokens are needed) when the call succeeds or throw a GSSException tokens are needed) when the call succeeds or throw a GSSException
skipping to change at page 91, line 30 skipping to change at page 91, line 30
While a Java method can never return a value and throw an While a Java method can never return a value and throw an
exception at the same time, we can embed the error token inside exception at the same time, we can embed the error token inside
the exception so that the caller has a chance to retrieve it. the exception so that the caller has a chance to retrieve it.
This update adds a new GSSException constructor to include this This update adds a new GSSException constructor to include this
token inside a GSSException object, and a getOutputToken() method token inside a GSSException object, and a getOutputToken() method
to retrieve the token. The specification for the initSecContext to retrieve the token. The specification for the initSecContext
and acceptSecContext methods are updated to describe the new and acceptSecContext methods are updated to describe the new
behavior. Various examples are also updated. behavior. Various examples are also updated.
New JGSS programs should make use of this new feature but it is New JGSS programs SHOULD make use of this new feature but it is
not mandatory. A program that intends to run with both old and not mandatory. A program that intends to run with both old and
new GSS Java bindings can use reflection to check the availability new GSS Java bindings can use reflection to check the availability
of this new method and call it accordingly. of this new method and call it accordingly.
2) Removing stream-based GSSContext methods 2) Removing stream-based GSSContext methods
The overloaded methods of GSSContext that use input and output The overloaded methods of GSSContext that use input and output
streams as the means to convey authentication and per-message GSS- streams as the means to convey authentication and per-message GSS-
API tokens as described in Section 5.15 of RFC 5653 [RFC5653] are API tokens as described in Section 5.15 of RFC 5653 [RFC5653] are
removed in this update as the wire protocol should be defined by removed in this update as the wire protocol should be defined by
skipping to change at page 92, line 5 skipping to change at page 92, line 5
implement these methods correctly when the token has no self- implement these methods correctly when the token has no self-
framing (where the end cannot be determined) or the library has no framing (where the end cannot be determined) or the library has no
knowledge of the token format (for example, as a bridge talking to knowledge of the token format (for example, as a bridge talking to
another GSS library). These methods include initSecContext another GSS library). These methods include initSecContext
(Section 7.4.5 of RFC 5653 [RFC5653]), acceptSecContext (Section 7.4.5 of RFC 5653 [RFC5653]), acceptSecContext
(Section 7.4.9 of RFC 5653 [RFC5653]), wrap (Section 7.4.15 of RFC (Section 7.4.9 of RFC 5653 [RFC5653]), wrap (Section 7.4.15 of RFC
5653 [RFC5653]), unwrap (Section 7.4.17 of RFC 5653 [RFC5653]), 5653 [RFC5653]), unwrap (Section 7.4.17 of RFC 5653 [RFC5653]),
getMIC (Section 7.4.19 of RFC 5653 [RFC5653]), and verifyMIC getMIC (Section 7.4.19 of RFC 5653 [RFC5653]), and verifyMIC
(Section 7.4.21 of RFC 5653 [RFC5653]). (Section 7.4.21 of RFC 5653 [RFC5653]).
12. Changes since RFC 2853 13. Changes since RFC 2853
This document has following changes: This document has following changes:
1) Major GSS Status Code Constant Values 1) Major GSS Status Code Constant Values
RFC 2853 listed all the GSS status code values in two different RFC 2853 listed all the GSS status code values in two different
sections: section 4.12.1 defined numeric values for them, and sections: section 4.12.1 defined numeric values for them, and
section 6.8.1 defined them as static constants in the GSSException section 6.8.1 defined them as static constants in the GSSException
class without assigning any values. Due to an inconsistent class without assigning any values. Due to an inconsistent
ordering between these two sections, all of the GSS major status ordering between these two sections, all of the GSS major status
codes resulted in misalignment, and a subsequent disagreement codes resulted in misalignment, and a subsequent disagreement
between deployed implementations. between deployed implementations.
This document defines the numeric values of the GSS status codes This document defines the numeric values of the GSS status codes
in both sections, while maintaining the original ordering from in both sections, while maintaining the original ordering from
section 6.8.1 of RFC 2853 [RFC2853], and obsoletes the GSS status section 6.8.1 of RFC 2853 [RFC2853], and obsoletes the GSS status
code values defined in section 4.12.1. The relevant sections in code values defined in section 4.12.1. The relevant sections in
this document are sections 4.12.1 and 6.8.1. this document are sections 5.12.1 and 7.8.1.
2) GSS Credential Usage Constant Values 2) GSS Credential Usage Constant Values
RFC 2853 section 6.3.2 defines static constants for the RFC 2853 section 6.3.2 defines static constants for the
GSSCredential usage flags. However, the values of these constants GSSCredential usage flags. However, the values of these constants
were not defined anywhere in RFC 2853 [RFC2853]. were not defined anywhere in RFC 2853 [RFC2853].
This document defines the credential usage values in section This document defines the credential usage values in section
6.3.1. The original ordering of these values from section 6.3.2 7.3.1. The original ordering of these values from section 6.3.2
of RFC 2853 [RFC2853] is maintained. of RFC 2853 [RFC2853] is maintained.
3) GSS Host-Based Service Name 3) GSS Host-Based Service Name
RFC 2853 [RFC2853], section 6.2.2, defines the static constant for RFC 2853 [RFC2853], section 6.2.2, defines the static constant for
the GSS host-based service OID NT_HOSTBASED_SERVICE, using a the GSS host-based service OID NT_HOSTBASED_SERVICE, using a
deprecated OID value. deprecated OID value.
This document updates the NT_HOSTBASED_SERVICE OID value in This document updates the NT_HOSTBASED_SERVICE OID value in
section 6.2.1 to be consistent with the C-bindings in RFC 2744 section 7.2.1 to be consistent with the C-bindings in RFC 2744
[RFC2744]. [RFC2744].
13. References 14. References
13.1. Normative References 14.1. Normative References
[RFC2025] Adams, C., "The Simple Public-Key GSS-API Mechanism [RFC2025] Adams, C., "The Simple Public-Key GSS-API Mechanism
(SPKM)", RFC 2025, DOI 10.17487/RFC2025, October 1996, (SPKM)", RFC 2025, DOI 10.17487/RFC2025, October 1996,
<https://www.rfc-editor.org/info/rfc2025>. <https://www.rfc-editor.org/info/rfc2025>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC2743] Linn, J., "Generic Security Service Application Program [RFC2743] Linn, J., "Generic Security Service Application Program
Interface Version 2, Update 1", RFC 2743, Interface Version 2, Update 1", RFC 2743,
DOI 10.17487/RFC2743, January 2000, DOI 10.17487/RFC2743, January 2000,
<https://www.rfc-editor.org/info/rfc2743>. <https://www.rfc-editor.org/info/rfc2743>.
[RFC2744] Wray, J., "Generic Security Service API Version 2 : [RFC2744] Wray, J., "Generic Security Service API Version 2 :
C-bindings", RFC 2744, DOI 10.17487/RFC2744, January 2000, C-bindings", RFC 2744, DOI 10.17487/RFC2744, January 2000,
<https://www.rfc-editor.org/info/rfc2744>. <https://www.rfc-editor.org/info/rfc2744>.
[RFC2853] Kabat, J. and M. Upadhyay, "Generic Security Service API [RFC2853] Kabat, J. and M. Upadhyay, "Generic Security Service API
skipping to change at page 93, line 36 skipping to change at page 93, line 41
Simple and Protected Generic Security Service Application Simple and Protected Generic Security Service Application
Program Interface (GSS-API) Negotiation Mechanism", Program Interface (GSS-API) Negotiation Mechanism",
RFC 4178, DOI 10.17487/RFC4178, October 2005, RFC 4178, DOI 10.17487/RFC4178, October 2005,
<https://www.rfc-editor.org/info/rfc4178>. <https://www.rfc-editor.org/info/rfc4178>.
[RFC5653] Upadhyay, M. and S. Malkani, "Generic Security Service API [RFC5653] Upadhyay, M. and S. Malkani, "Generic Security Service API
Version 2: Java Bindings Update", RFC 5653, Version 2: Java Bindings Update", RFC 5653,
DOI 10.17487/RFC5653, August 2009, DOI 10.17487/RFC5653, August 2009,
<https://www.rfc-editor.org/info/rfc5653>. <https://www.rfc-editor.org/info/rfc5653>.
13.2. Informative References [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
14.2. Informative References
[JLS] Gosling, J., Joy, B., Steele, G., and G. Bracha, "The Java [JLS] Gosling, J., Joy, B., Steele, G., and G. Bracha, "The Java
Language Specification", Third Edition, 2005, Language Specification", Third Edition, 2005,
<http://java.sun.com/docs/books/jls/>. <http://java.sun.com/docs/books/jls/>.
Authors' Addresses Authors' Addresses
Mayank D. Upadhyay Mayank D. Upadhyay
Google Inc. Google Inc.
1600 Amphitheatre Parkway 1600 Amphitheatre Parkway
 End of changes. 320 change blocks. 
506 lines changed or deleted 525 lines changed or added

This html diff was produced by rfcdiff 1.46. The latest version is available from http://tools.ietf.org/tools/rfcdiff/