draft-ietf-cat-gssv2-javabind-04.txt   rfc2853.txt 
Internet-Draft Jack Kabat
IETF CAT Working Group ValiCert, Inc.
Document: <draft-ietf-cat-gssv2-javabind-04.txt> Mayank Upadhyay
Sun Microsystems, Inc.
December 1999 Network Working Group J. Kabat
Request for Comments: 2853 ValiCert, Inc.
Category: Standards Track M. Upadhyay
Sun Microsystems, Inc.
June 2000
Generic Security Service API Version 2 : Java bindings Generic Security Service API Version 2 : Java Bindings
Status of this Memo Status of this Memo
This document is an Internet-Draft and is in full conformance with This document specifies an Internet standards track protocol for the
all provisions of Section 10 of RFC2026. Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Internet-Drafts are working documents of the Internet Engineering Official Protocol Standards" (STD 1) for the standardization state
Task Force (IETF), its areas, and its working groups. Note that and status of this protocol. Distribution of this memo is unlimited.
other groups may also distribute working documents as Internet-
Drafts.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet- Drafts as reference
material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at Copyright Notice
http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed at Copyright (C) The Internet Society (2000). All Rights Reserved.
http://www.ietf.org/shadow.html.
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
specifies the Java bindings for GSS-API which is described at a specifies the Java bindings for GSS-API which is described at a
language independent conceptual level in RFC 2078 [GSSAPIv2]. language independent conceptual level in RFC 2743 [GSSAPIv2-UPDATE].
The GSS-API allows a caller application to authenticate a principal The GSS-API allows a caller application to authenticate a principal
identity, to delegate rights to a peer, and to apply security identity, to delegate rights to a peer, and to apply security
services such as confidentiality and integrity on a per-message services such as confidentiality and integrity on a per-message
basis. Examples of security mechanisms defined for GSS-API are The basis. Examples of security mechanisms defined for GSS-API are The
Simple Public-Key GSS-API Mechanism [SPKM] and The Kerberos Version 5 Simple Public-Key GSS-API Mechanism [SPKM] and The Kerberos Version 5
GSS-API Mechanism [KERBV5]. GSS-API Mechanism [KERBV5].
GSS-API Java Bindings December 1999
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 6 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . 5
2. GSS-API Operational Paradigm . . . . . . . . . . . . . . . . 7 2. GSS-API Operational Paradigm . . . . . . . . . . . . . . . 6
3. Additional Controls . . . . . . . . . . . . . . . . . . . . 8 3. Additional Controls . . . . . . . . . . . . . . . . . . . 8
3.1. Delegation . . . . . . . . . . . . . . . . . . . . . . . . 9 3.1. Delegation . . . . . . . . . . . . . . . . . . . . . . . 9
3.2. Mutual Authentication . . . . . . . . . . . . . . . . . 10 3.2. Mutual Authentication . . . . . . . . . . . . . . . . . 10
3.3. Replay and Out-of-Sequence Detection . . . . . . . . . . 11 3.3. Replay and Out-of-Sequence Detection . . . . . . . . . . 10
3.4. Anonymous Authentication . . . . . . . . . . . . . . . . 11 3.4. Anonymous Authentication . . . . . . . . . . . . . . . . 11
3.5. Confidentiality . . . . . . . . . . . . . . . . . . . . 12 3.5. Confidentiality . . . . . . . . . . . . . . . . . . . . 12
3.6. Inter-process Context Transfer . . . . . . . . . . . . . 13 3.6. Inter-process Context Transfer . . . . . . . . . . . . . 12
3.7. The Use of Incomplete Contexts . . . . . . . . . . . . . 13 3.7. The Use of Incomplete Contexts . . . . . . . . . . . . . 13
4. Calling Conventions . . . . . . . . . . . . . . . . . . . 14 4. Calling Conventions . . . . . . . . . . . . . . . . . . . 13
4.1. Package Name . . . . . . . . . . . . . . . . . . . . . . 14 4.1. Package Name . . . . . . . . . . . . . . . . . . . . . . 13
4.2. Provider Framework . . . . . . . . . . . . . . . . . . . 14 4.2. Provider Framework . . . . . . . . . . . . . . . . . . . 13
4.3. Integer types . . . . . . . . . . . . . . . . . . . . . 15 4.3. Integer types . . . . . . . . . . . . . . . . . . . . . 14
4.4. Opaque Data types . . . . . . . . . . . . . . . . . . . 15 4.4. Opaque Data types . . . . . . . . . . . . . . . . . . . 14
4.5. Strings . . . . . . . . . . . . . . . . . . . . . . . . 15 4.5. Strings . . . . . . . . . . . . . . . . . . . . . . . . 15
4.6. Object Identifiers . . . . . . . . . . . . . . . . . . . 16 4.6. Object Identifiers . . . . . . . . . . . . . . . . . . . 15
4.7. Object Identifier Sets . . . . . . . . . . . . . . . . . 16 4.7. Object Identifier Sets . . . . . . . . . . . . . . . . . 15
4.8. Credentials . . . . . . . . . . . . . . . . . . . . . . 16 4.8. Credentials . . . . . . . . . . . . . . . . . . . . . . 16
4.9. Contexts . . . . . . . . . . . . . . . . . . . . . . . . 18 4.9. Contexts . . . . . . . . . . . . . . . . . . . . . . . . 18
4.10. Authentication tokens . . . . . . . . . . . . . . . . . 19 4.10. Authentication tokens . . . . . . . . . . . . . . . . . 18
4.11. Interprocess tokens . . . . . . . . . . . . . . . . . . 19 4.11. Interprocess tokens . . . . . . . . . . . . . . . . . . 18
4.12. Error Reporting . . . . . . . . . . . . . . . . . . . . 20 4.12. Error Reporting . . . . . . . . . . . . . . . . . . . . 19
4.12.1. GSS status codes . . . . . . . . . . . . . . . . . . 20 4.12.1. GSS status codes . . . . . . . . . . . . . . . . . . 19
4.12.2. Mechanism-specific status codes . . . . . . . . . . . 22 4.12.2. Mechanism-specific status codes . . . . . . . . . . . 21
4.12.3. Supplementary status codes . . . . . . . . . . . . . 22 4.12.3. Supplementary status codes . . . . . . . . . . . . . 21
4.13. Names . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.13. Names . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.14. Channel Bindings . . . . . . . . . . . . . . . . . . . 26 4.14. Channel Bindings . . . . . . . . . . . . . . . . . . . 25
4.15. Stream Objects . . . . . . . . . . . . . . . . . . . . 27 4.15. Stream Objects . . . . . . . . . . . . . . . . . . . . 26
4.16. Optional Parameters . . . . . . . . . . . . . . . . . . 27 4.16. Optional Parameters . . . . . . . . . . . . . . . . . . 26
5. Introduction to GSS-API Classes and Interfaces . . . . . . 27 5. Introduction to GSS-API Classes and Interfaces . . . . . . 26
5.1. GSSManager class . . . . . . . . . . . . . . . . . . . . 28 5.1. GSSManager class . . . . . . . . . . . . . . . . . . . . 26
5.2. GSSName interface . . . . . . . . . . . . . . . . . . . 28 5.2. GSSName interface . . . . . . . . . . . . . . . . . . . 27
5.3. GSSCredential interface . . . . . . . . . . . . . . . . 29 5.3. GSSCredential interface . . . . . . . . . . . . . . . . 28
5.4. GSSContext interface . . . . . . . . . . . . . . . . . . 30 5.4. GSSContext interface . . . . . . . . . . . . . . . . . . 28
5.5. MessageProp class . . . . . . . . . . . . . . . . . . . 31 5.5. MessageProp class . . . . . . . . . . . . . . . . . . . 30
5.6. GSSException class . . . . . . . . . . . . . . . . . . . 31 5.6. GSSException class . . . . . . . . . . . . . . . . . . . 30
5.7. Oid class . . . . . . . . . . . . . . . . . . . . . . . 32 5.7. Oid class . . . . . . . . . . . . . . . . . . . . . . . 30
5.8. ChannelBinding class . . . . . . . . . . . . . . . . . . 32 5.8. ChannelBinding class . . . . . . . . . . . . . . . . . . 31
6. Detailed GSS-API Class Description . . . . . . . . . . . . 32 6. Detailed GSS-API Class Description . . . . . . . . . . . . 31
6.1. public abstract class GSSManager . . . . . . . . . . . . 32 6.1. public abstract class GSSManager . . . . . . . . . . . . 31
6.1.1. Example Code . . . . . . . . . . . . . . . . . . . . . 34 6.1.1. Example Code . . . . . . . . . . . . . . . . . . . . . 32
6.1.2. getInstance . . . . . . . . . . . . . . . . . . . . . 34 6.1.2. getInstance . . . . . . . . . . . . . . . . . . . . . 33
6.1.3. getMechs . . . . . . . . . . . . . . . . . . . . . . . 34 6.1.3. getMechs . . . . . . . . . . . . . . . . . . . . . . . 33
6.1.4. getNamesForMech . . . . . . . . . . . . . . . . . . . 34 6.1.4. getNamesForMech . . . . . . . . . . . . . . . . . . . 33
6.1.5. getMechsForName . . . . . . . . . . . . . . . . . . . 35 6.1.5. getMechsForName . . . . . . . . . . . . . . . . . . . 33
6.1.6. createName . . . . . . . . . . . . . . . . . . . . . . 33
GSS-API Java Bindings December 1999 6.1.7. createName . . . . . . . . . . . . . . . . . . . . . . 34
6.1.8. createName . . . . . . . . . . . . . . . . . . . . . . 35
6.1.6. createName . . . . . . . . . . . . . . . . . . . . . . 35 6.1.9. createName . . . . . . . . . . . . . . . . . . . . . . 35
6.1.7. createName . . . . . . . . . . . . . . . . . . . . . . 36 6.1.10. createCredential . . . . . . . . . . . . . . . . . . 36
6.1.8. createName . . . . . . . . . . . . . . . . . . . . . . 36 6.1.11. createCredential . . . . . . . . . . . . . . . . . . 36
6.1.9. createName . . . . . . . . . . . . . . . . . . . . . . 37 6.1.12. createCredential . . . . . . . . . . . . . . . . . . 37
6.1.10. createCredential . . . . . . . . . . . . . . . . . . 37 6.1.13. createContext . . . . . . . . . . . . . . . . . . . . 37
6.1.11. createCredential . . . . . . . . . . . . . . . . . . 38 6.1.14. createContext . . . . . . . . . . . . . . . . . . . . 38
6.1.12. createCredential . . . . . . . . . . . . . . . . . . 38 6.1.15. createContext . . . . . . . . . . . . . . . . . . . . 38
6.1.13. createContext . . . . . . . . . . . . . . . . . . . . 39 6.1.16. addProviderAtFront . . . . . . . . . . . . . . . . . 38
6.1.14. createContext . . . . . . . . . . . . . . . . . . . . 39 6.1.16.1. Example Code . . . . . . . . . . . . . . . . . . . 39
6.1.15. createContext . . . . . . . . . . . . . . . . . . . . 40 6.1.17. addProviderAtEnd . . . . . . . . . . . . . . . . . . 40
6.1.16. addProviderAtFront . . . . . . . . . . . . . . . . . 40 6.1.17.1. Example Code . . . . . . . . . . . . . . . . . . . 41
6.1.16.1. Example Code . . . . . . . . . . . . . . . . . . . 41 6.2. public interface GSSName . . . . . . . . . . . . . . . . 42
6.1.17. addProviderAtEnd . . . . . . . . . . . . . . . . . . 42 6.2.1. Example Code . . . . . . . . . . . . . . . . . . . . . 42
6.1.17.1. Example Code . . . . . . . . . . . . . . . . . . . 42 6.2.2. Static Constants . . . . . . . . . . . . . . . . . . . 43
6.2. public interface GSSName . . . . . . . . . . . . . . . . 43 6.2.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 44
6.2.1. Example Code . . . . . . . . . . . . . . . . . . . . . 43 6.2.4. equals . . . . . . . . . . . . . . . . . . . . . . . . 44
6.2.2. Static Constants . . . . . . . . . . . . . . . . . . . 44 6.2.5. canonicalize . . . . . . . . . . . . . . . . . . . . . 44
6.2.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 45 6.2.6. export . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.4. equals . . . . . . . . . . . . . . . . . . . . . . . . 45 6.2.7. toString . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.5. canonicalize . . . . . . . . . . . . . . . . . . . . . 46 6.2.8. getStringNameType . . . . . . . . . . . . . . . . . . 45
6.2.6. export . . . . . . . . . . . . . . . . . . . . . . . . 46 6.2.9. isAnonymous . . . . . . . . . . . . . . . . . . . . . 45
6.2.7. toString . . . . . . . . . . . . . . . . . . . . . . . 46 6.2.10. isMN . . . . . . . . . . . . . . . . . . . . . . . . 45
6.2.8. getStringNameType . . . . . . . . . . . . . . . . . . 47 6.3. public interface GSSCredential implements Cloneable . . 45
6.2.9. isAnonymous . . . . . . . . . . . . . . . . . . . . . 47 6.3.1. Example Code . . . . . . . . . . . . . . . . . . . . . 46
6.2.10. isMN . . . . . . . . . . . . . . . . . . . . . . . . 47 6.3.2. Static Constants . . . . . . . . . . . . . . . . . . . 47
6.3. public interface GSSCredential implements Cloneable . . 47 6.3.3. dispose . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.1. Example Code . . . . . . . . . . . . . . . . . . . . . 48 6.3.4. getName . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.2. Static Constants . . . . . . . . . . . . . . . . . . . 49 6.3.5. getName . . . . . . . . . . . . . . . . . . . . . . . 48
6.3.3. dispose . . . . . . . . . . . . . . . . . . . . . . . 49 6.3.6. getRemainingLifetime . . . . . . . . . . . . . . . . . 48
6.3.4. getName . . . . . . . . . . . . . . . . . . . . . . . 50 6.3.7. getRemainingInitLifetime . . . . . . . . . . . . . . . 49
6.3.5. getName . . . . . . . . . . . . . . . . . . . . . . . 50 6.3.8. getRemainingAcceptLifetime . . . . . . . . . . . . . . 49
6.3.6. getRemainingLifetime . . . . . . . . . . . . . . . . . 50 6.3.9. getUsage . . . . . . . . . . . . . . . . . . . . . . . 49
6.3.7. getRemainingInitLifetime . . . . . . . . . . . . . . . 50 6.3.10. getUsage . . . . . . . . . . . . . . . . . . . . . . 49
6.3.8. getRemainingAcceptLifetime . . . . . . . . . . . . . . 51 6.3.11. getMechs . . . . . . . . . . . . . . . . . . . . . . 50
6.3.9. getUsage . . . . . . . . . . . . . . . . . . . . . . . 51 6.3.12. add . . . . . . . . . . . . . . . . . . . . . . . . . 50
6.3.10. getUsage . . . . . . . . . . . . . . . . . . . . . . 51 6.3.13. equals . . . . . . . . . . . . . . . . . . . . . . . 51
6.3.11. getMechs . . . . . . . . . . . . . . . . . . . . . . 51 6.4. public interface GSSContext . . . . . . . . . . . . . . 51
6.3.12. add . . . . . . . . . . . . . . . . . . . . . . . . . 52 6.4.1. Example Code . . . . . . . . . . . . . . . . . . . . . 52
6.3.13. equals . . . . . . . . . . . . . . . . . . . . . . . 52 6.4.2. Static Constants . . . . . . . . . . . . . . . . . . . 54
6.4. public interface GSSContext . . . . . . . . . . . . . . 53 6.4.3. initSecContext . . . . . . . . . . . . . . . . . . . . 54
6.4.1. Example Code . . . . . . . . . . . . . . . . . . . . . 54 6.4.3.1. Example Code . . . . . . . . . . . . . . . . . . . . 55
6.4.2. Static Constants . . . . . . . . . . . . . . . . . . . 56 6.4.4. initSecContext . . . . . . . . . . . . . . . . . . . . 56
6.4.3. initSecContext . . . . . . . . . . . . . . . . . . . . 56 6.4.4.1. Example Code . . . . . . . . . . . . . . . . . . . . 56
6.4.3.1. Example Code . . . . . . . . . . . . . . . . . . . . 56 6.4.5. acceptSecContext . . . . . . . . . . . . . . . . . . . 57
6.4.4. initSecContext . . . . . . . . . . . . . . . . . . . . 57 6.4.5.1. Example Code . . . . . . . . . . . . . . . . . . . . 58
6.4.4.1. Example Code . . . . . . . . . . . . . . . . . . . . 58 6.4.6. acceptSecContext . . . . . . . . . . . . . . . . . . . 59
6.4.5. acceptSecContext . . . . . . . . . . . . . . . . . . . 59 6.4.6.1. Example Code . . . . . . . . . . . . . . . . . . . . 59
6.4.5.1. Example Code . . . . . . . . . . . . . . . . . . . . 59 6.4.7. isEstablished . . . . . . . . . . . . . . . . . . . . 60
6.4.8. dispose . . . . . . . . . . . . . . . . . . . . . . . 60
GSS-API Java Bindings December 1999 6.4.9. getWrapSizeLimit . . . . . . . . . . . . . . . . . . . 61
6.4.10. wrap . . . . . . . . . . . . . . . . . . . . . . . . 61
6.4.6. acceptSecContext . . . . . . . . . . . . . . . . . . . 60 6.4.11. wrap . . . . . . . . . . . . . . . . . . . . . . . . 62
6.4.6.1. Example Code . . . . . . . . . . . . . . . . . . . . 61 6.4.12. unwrap . . . . . . . . . . . . . . . . . . . . . . . 63
6.4.7. isEstablished . . . . . . . . . . . . . . . . . . . . 62 6.4.13. unwrap . . . . . . . . . . . . . . . . . . . . . . . 64
6.4.8. dispose . . . . . . . . . . . . . . . . . . . . . . . 62 6.4.14. getMIC . . . . . . . . . . . . . . . . . . . . . . . 65
6.4.9. getWrapSizeLimit . . . . . . . . . . . . . . . . . . . 62 6.4.15. getMIC . . . . . . . . . . . . . . . . . . . . . . . 65
6.4.10. wrap . . . . . . . . . . . . . . . . . . . . . . . . 63 6.4.16. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 66
6.4.11. wrap . . . . . . . . . . . . . . . . . . . . . . . . 64 6.4.17. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 67
6.4.12. unwrap . . . . . . . . . . . . . . . . . . . . . . . 65 6.4.18. export . . . . . . . . . . . . . . . . . . . . . . . 68
6.4.13. unwrap . . . . . . . . . . . . . . . . . . . . . . . 65 6.4.19. requestMutualAuth . . . . . . . . . . . . . . . . . . 68
6.4.14. getMIC . . . . . . . . . . . . . . . . . . . . . . . 66 6.4.20. requestReplayDet . . . . . . . . . . . . . . . . . . 69
6.4.15. getMIC . . . . . . . . . . . . . . . . . . . . . . . 67 6.4.21. requestSequenceDet . . . . . . . . . . . . . . . . . 69
6.4.16. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 67 6.4.22. requestCredDeleg . . . . . . . . . . . . . . . . . . 69
6.4.17. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 68 6.4.23. requestAnonymity . . . . . . . . . . . . . . . . . . 69
6.4.18. export . . . . . . . . . . . . . . . . . . . . . . . 69 6.4.24. requestConf . . . . . . . . . . . . . . . . . . . . . 70
6.4.19. requestMutualAuth . . . . . . . . . . . . . . . . . . 70 6.4.25. requestInteg . . . . . . . . . . . . . . . . . . . . 70
6.4.20. requestReplayDet . . . . . . . . . . . . . . . . . . 70 6.4.26. requestLifetime . . . . . . . . . . . . . . . . . . . 70
6.4.21. requestSequenceDet . . . . . . . . . . . . . . . . . 70 6.4.27. setChannelBinding . . . . . . . . . . . . . . . . . . 71
6.4.22. requestCredDeleg . . . . . . . . . . . . . . . . . . 71 6.4.28. getCredDelegState . . . . . . . . . . . . . . . . . . 71
6.4.23. requestAnonymity . . . . . . . . . . . . . . . . . . 71 6.4.29. getMutualAuthState . . . . . . . . . . . . . . . . . 71
6.4.24. requestConf . . . . . . . . . . . . . . . . . . . . . 71 6.4.30. getReplayDetState . . . . . . . . . . . . . . . . . . 71
6.4.25. requestInteg . . . . . . . . . . . . . . . . . . . . 71 6.4.31. getSequenceDetState . . . . . . . . . . . . . . . . . 71
6.4.26. requestLifetime . . . . . . . . . . . . . . . . . . . 72 6.4.32. getAnonymityState . . . . . . . . . . . . . . . . . . 72
6.4.27. setChannelBinding . . . . . . . . . . . . . . . . . . 72 6.4.33. isTransferable . . . . . . . . . . . . . . . . . . . 72
6.4.28. getCredDelegState . . . . . . . . . . . . . . . . . . 72 6.4.34. isProtReady . . . . . . . . . . . . . . . . . . . . . 72
6.4.29. getMutualAuthState . . . . . . . . . . . . . . . . . 72 6.4.35. getConfState . . . . . . . . . . . . . . . . . . . . 72
6.4.30. getReplayDetState . . . . . . . . . . . . . . . . . . 73 6.4.36. getIntegState . . . . . . . . . . . . . . . . . . . . 72
6.4.31. getSequenceDetState . . . . . . . . . . . . . . . . . 73 6.4.37. getLifetime . . . . . . . . . . . . . . . . . . . . . 73
6.4.32. getAnonymityState . . . . . . . . . . . . . . . . . . 73 6.4.38. getSrcName . . . . . . . . . . . . . . . . . . . . . 73
6.4.33. isTransferable . . . . . . . . . . . . . . . . . . . 73 6.4.39. getTargName . . . . . . . . . . . . . . . . . . . . . 73
6.4.34. isProtReady . . . . . . . . . . . . . . . . . . . . . 74 6.4.40. getMech . . . . . . . . . . . . . . . . . . . . . . . 73
6.4.35. getConfState . . . . . . . . . . . . . . . . . . . . 74 6.4.41. getDelegCred . . . . . . . . . . . . . . . . . . . . 73
6.4.36. getIntegState . . . . . . . . . . . . . . . . . . . . 74 6.4.42. isInitiator . . . . . . . . . . . . . . . . . . . . . 73
6.4.37. getLifetime . . . . . . . . . . . . . . . . . . . . . 74 6.5. public class MessageProp . . . . . . . . . . . . . . . . 74
6.4.38. getSrcName . . . . . . . . . . . . . . . . . . . . . 74 6.5.1. Constructors . . . . . . . . . . . . . . . . . . . . . 74
6.4.39. getTargName . . . . . . . . . . . . . . . . . . . . . 75 6.5.2. getQOP . . . . . . . . . . . . . . . . . . . . . . . . 75
6.4.40. getMech . . . . . . . . . . . . . . . . . . . . . . . 75 6.5.3. getPrivacy . . . . . . . . . . . . . . . . . . . . . . 75
6.4.41. getDelegCred . . . . . . . . . . . . . . . . . . . . 75 6.5.4. getMinorStatus . . . . . . . . . . . . . . . . . . . . 75
6.4.42. isInitiator . . . . . . . . . . . . . . . . . . . . . 75 6.5.5. getMinorString . . . . . . . . . . . . . . . . . . . . 75
6.5. public class MessageProp . . . . . . . . . . . . . . . . 75 6.5.6. setQOP . . . . . . . . . . . . . . . . . . . . . . . . 75
6.5.1. Constructors . . . . . . . . . . . . . . . . . . . . . 76 6.5.7. setPrivacy . . . . . . . . . . . . . . . . . . . . . . 75
6.5.2. getQOP . . . . . . . . . . . . . . . . . . . . . . . . 76 6.5.8. isDuplicateToken . . . . . . . . . . . . . . . . . . . 76
6.5.3. getPrivacy . . . . . . . . . . . . . . . . . . . . . . 76 6.5.9. isOldToken . . . . . . . . . . . . . . . . . . . . . . 76
6.5.4. getMinorStatus . . . . . . . . . . . . . . . . . . . . 77 6.5.10. isUnseqToken . . . . . . . . . . . . . . . . . . . . 76
6.5.5. getMinorString . . . . . . . . . . . . . . . . . . . . 77 6.5.11. isGapToken . . . . . . . . . . . . . . . . . . . . . 76
6.5.6. setQOP . . . . . . . . . . . . . . . . . . . . . . . . 77 6.5.12. setSupplementaryStates . . . . . . . . . . . . . . . 76
6.5.7. setPrivacy . . . . . . . . . . . . . . . . . . . . . . 77 6.6. public class ChannelBinding . . . . . . . . . . . . . . 77
6.5.8. isDuplicateToken . . . . . . . . . . . . . . . . . . . 77 6.6.1. Constructors . . . . . . . . . . . . . . . . . . . . . 77
6.5.9. isOldToken . . . . . . . . . . . . . . . . . . . . . . 78 6.6.2. getInitiatorAddress . . . . . . . . . . . . . . . . . 78
6.6.3. getAcceptorAddress . . . . . . . . . . . . . . . . . . 78
GSS-API Java Bindings December 1999 6.6.4. getApplicationData . . . . . . . . . . . . . . . . . . 78
6.6.5. equals . . . . . . . . . . . . . . . . . . . . . . . . 78
6.5.10. isUnseqToken . . . . . . . . . . . . . . . . . . . . 78 6.7. public class Oid . . . . . . . . . . . . . . . . . . . . 79
6.5.11. isGapToken . . . . . . . . . . . . . . . . . . . . . 78 6.7.1. Constructors . . . . . . . . . . . . . . . . . . . . . 79
6.5.12. setSupplementaryStates . . . . . . . . . . . . . . . 78 6.7.2. toString . . . . . . . . . . . . . . . . . . . . . . . 80
6.6. public class ChannelBinding . . . . . . . . . . . . . . 79 6.7.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 80
6.6.1. Constructors . . . . . . . . . . . . . . . . . . . . . 79 6.7.4. getDER . . . . . . . . . . . . . . . . . . . . . . . . 80
6.6.2. getInitiatorAddress . . . . . . . . . . . . . . . . . 80 6.7.5. containedIn . . . . . . . . . . . . . . . . . . . . . 80
6.6.3. getAcceptorAddress . . . . . . . . . . . . . . . . . . 80 6.8. public class GSSException extends Exception . . . . . . 80
6.6.4. getApplicationData . . . . . . . . . . . . . . . . . . 80 6.8.1. Static Constants . . . . . . . . . . . . . . . . . . . 81
6.6.5. equals . . . . . . . . . . . . . . . . . . . . . . . . 80 6.8.2. Constructors . . . . . . . . . . . . . . . . . . . . . 83
6.7. public class Oid . . . . . . . . . . . . . . . . . . . . 81 6.8.3. getMajor . . . . . . . . . . . . . . . . . . . . . . . 84
6.7.1. Constructors . . . . . . . . . . . . . . . . . . . . . 81 6.8.4. getMinor . . . . . . . . . . . . . . . . . . . . . . . 84
6.7.2. toString . . . . . . . . . . . . . . . . . . . . . . . 82 6.8.5. getMajorString . . . . . . . . . . . . . . . . . . . . 84
6.7.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 82 6.8.6. getMinorString . . . . . . . . . . . . . . . . . . . . 84
6.7.4. getDER . . . . . . . . . . . . . . . . . . . . . . . . 82 6.8.7. setMinor . . . . . . . . . . . . . . . . . . . . . . . 84
6.7.5. containedIn . . . . . . . . . . . . . . . . . . . . . 82 6.8.8. toString . . . . . . . . . . . . . . . . . . . . . . . 85
6.8. public class GSSException extends Exception . . . . . . 83 6.8.9. getMessage . . . . . . . . . . . . . . . . . . . . . . 85
6.8.1. Static Constants . . . . . . . . . . . . . . . . . . . 83 7. Sample Applications . . . . . . . . . . . . . . . . . . . 85
6.8.2. Constructors . . . . . . . . . . . . . . . . . . . . . 86 7.1. Simple GSS Context Initiator . . . . . . . . . . . . . . 85
6.8.3. getMajor . . . . . . . . . . . . . . . . . . . . . . . 86 7.2. Simple GSS Context Acceptor . . . . . . . . . . . . . . 89
6.8.4. getMinor . . . . . . . . . . . . . . . . . . . . . . . 86 8. Security Considerations . . . . . . . . . . . . . . . . . 93
6.8.5. getMajorString . . . . . . . . . . . . . . . . . . . . 87 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . 94
6.8.6. getMinorString . . . . . . . . . . . . . . . . . . . . 87 10. Bibliography . . . . . . . . . . . . . . . . . . . . . . 94
6.8.7. setMinor . . . . . . . . . . . . . . . . . . . . . . . 87 11. Authors' Addresses . . . . . . . . . . . . . . . . . . . 95
6.8.8. toString . . . . . . . . . . . . . . . . . . . . . . . 87 12. Full Copyright Statement. . . . . . . . . . . . . . . . . 96
6.8.9. getMessage . . . . . . . . . . . . . . . . . . . . . . 87
7. Sample Applications . . . . . . . . . . . . . . . . . . . 88
7.1. Simple GSS Context Initiator . . . . . . . . . . . . . . 88
7.2. Simple GSS Context Acceptor . . . . . . . . . . . . . . 92
8. Security Considerations . . . . . . . . . . . . . . . . . 96
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . 97
10. Bibliography . . . . . . . . . . . . . . . . . . . . . . 98
11. Author's Address . . . . . . . . . . . . . . . . . . . . 99
GSS-API Java Bindings December 1999
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 (GSS-API) Version Security Services Application Programming Interface Version 2 (GSS-
2. GSS-API Version 2 is described in a language independent format in API). GSS-API Version 2 is described in a language independent
RFC 2078 [GSSAPIv2]. The GSS-API allows a caller application to format in RFC 2743 [GSSAPIv2-UPDATE]. The GSS-API allows a caller
authenticate a principal identity, to delegate rights to a peer, and application to authenticate a principal identity, to delegate rights
to apply security services such as confidentiality and integrity on a to a peer, and to apply security services such as confidentiality and
per-message basis. integrity on a per-message basis.
This document leverages the work performed by the WG in the area of This document leverages the work performed by the WG in the area of
RFC 2078 [GSSAPIv2] the C-bindings draft [GSSAPI-C]. Whenever RFC 2743 [GSSAPIv2-UPDATE] and the C-bindings RFC 2744 [GSSAPI-C].
appropriate, text has been used from the C-bindings document to Whenever appropriate, text has been used from the C-bindings RFC 2744
explain generic concepts and provide direction to the implementors. to explain generic concepts and provide direction to the
implementors.
The design goals of this API have been to satisfy all the The design goals of this API have been to satisfy all the
functionality defined in RFC 2078 and to provide these services in an functionality defined in RFC 2743 and to provide these services in an
object oriented method. The specification also aims to satisfy the object oriented method. The specification also aims to satisfy the
needs of both types of Java application developers, those who would needs of both types of Java application developers, those who would
like access to a "system-wide" GSS-API implementation, as well as like access to a "system-wide" GSS-API implementation, as well as
those who would want to provide their own "custom" implementation. those who would want to provide their own "custom" implementation.
A "system-wide" implementation is one that is available to all A "system-wide" implementation is one that is available to all
applications in the form of a library package. It may be a standard applications in the form of a library package. It may be a standard
package in the Java runtime environment (JRE) being used or it may be package in the Java runtime environment (JRE) being used or it may be
additionally installed and accessible to any application via the additionally installed and accessible to any application via the
CLASSPATH. CLASSPATH.
A "custom" implementation of the GSS-API, on the other hand, is one A "custom" implementation of the GSS-API, on the other hand, is one
that would, in most cases, be bundled with the application during that would, in most cases, be bundled with the application during
distribution. It is expected that such an implementation would be distribution. It is expected that such an implementation would be
meant to provide for some particular need of the application, such as meant to provide for some particular need of the application, such as
support for some specific mechanism. support for some specific mechanism.
The design of this API also aims to provide a flexible framework to The design of this API also aims to provide a flexible framework to
add and manage GSS-API mechanisms. GSS-API leverages the JCA provider add and manage GSS-API mechanisms. GSS-API leverages the Java
concept to support the plugability of mechanisms. Mechanisms can be Cryptography Architecture (JCA) provider model to support the
added on a "system-wide" basis, where all users of the framework will plugability of mechanisms. Mechanisms can be added on a "system-
have them available. The specification also allows for the addition wide" basis, where all users of the framework will have them
of mechanisms per-instance the GSS-API. available. The specification also allows for the addition of
mechanisms per-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.
GSS-API Java Bindings December 1999
2. GSS-API Operational Paradigm 2. GSS-API Operational Paradigm
The Generic Security Service Application Programming Interface The Generic Security Service Application Programming Interface
[GSSAPIv2] defines a generic security API to calling applications. Version 2 [GSSAPIv2-UPDATE] defines a generic security API to calling
It allows a communicating application to authenticate the user applications. It allows a communicating application to authenticate
associated with another application, to delegate rights to another the user associated with another application, to delegate rights to
application, and to apply security services such as confidentiality another application, and to apply security services such as
and integrity on a per-message basis. confidentiality and integrity on a per-message basis.
There are four stages to using GSS-API:
1) The application acquires a set of credentials with which it There are four stages to using GSS-API:
may prove its identity to other processes. The
application's credentials vouch for its global identity,
which may or may not be related to any local username under
which it may be running.
2) A pair of communicating applications establish a joint 1) The application acquires a set of credentials with which it may
security context using their credentials. The security prove its identity to other processes. The application's
context encapsulates shared state information, which is credentials vouch for its global identity, which may or may not
required in order that per-message security services may be be related to any local username under which it may be running.
provided. Examples of state information that might be
shared between applications as part of a security context
are cryptographic keys, and message sequence numbers. As
part of the establishment of a security context, the
context initiator is authenticated to the responder, and
may require that the responder is authenticated back to the
initiator. The initiator may optionally give the responder
the right to initiate further security contexts, acting as
an agent or delegate of the initiator. This transfer of
rights is termed "delegation", and is achieved by creating
a set of credentials, similar to those used by the
initiating application, but which may be used by the
responder.
A GSSContext object is used to establish and maintain the 2) A pair of communicating applications establish a joint security
shared information that makes up the security context. context using their credentials. The security context
Certain GSSContext methods will generate a token, which encapsulates shared state information, which is required in
applications treat as cryptographically protected, opaque order that per-message security services may be provided.
data. The caller of such GSSContext method is responsible Examples of state information that might be shared between
for transferring the token to the peer application, applications as part of a security context are cryptographic
encapsulated if necessary in an application-to-application keys, and message sequence numbers. As part of the
protocol. On receipt of such a token, the peer application establishment of a security context, the context initiator is
should pass it to a corresponding GSSContext method which authenticated to the responder, and may require that the
will decode the token and extract the information, updating responder is authenticated back to the initiator. The
the security context state information accordingly. initiator may optionally give the responder the right to
initiate further security contexts, acting as an agent or
delegate of the initiator. This transfer of rights is termed
"delegation", and is achieved by creating a set of credentials,
similar to those used by the initiating application, but which
may be used by the responder.
GSS-API Java Bindings December 1999 A GSSContext object is used to establish and maintain the
shared information that makes up the security context. Certain
GSSContext methods will generate a token, which applications
treat as cryptographically protected, opaque data. The caller
of such GSSContext method is responsible for transferring the
token to the peer application, encapsulated if necessary in an
application-to-application protocol. On receipt of such a
token, the peer application should pass it to a corresponding
GSSContext method which will decode the token and extract the
information, updating the security context state information
accordingly.
3) Per-message services are invoked on a GSSContext object to 3) Per-message services are invoked on a GSSContext object to
apply either: apply either:
integrity and data origin authentication, or integrity and data origin authentication, or
confidentiality, integrity and data origin confidentiality, integrity and data origin authentication
authentication
to application data, which are treated by GSS-API as to application data, which are treated by GSS-API as arbitrary
arbitrary octet-strings. An application transmitting a octet-strings. An application transmitting a message that it
message that it wishes to protect will call the appropriate wishes to protect will call the appropriate GSSContext method
GSSContext method (getMIC or wrap) to apply protection, and (getMIC or wrap) to apply protection, and send the resulting
send the resulting token to the receiving application. The token to the receiving application. The receiver will pass the
receiver will pass the received token (and, in the case of received token (and, in the case of data protected by getMIC,
data protected by getMIC, the accompanying message-data) to the accompanying message-data) to the corresponding decoding
the corresponding decoding method of the GSSContext method of the GSSContext interface (verifyMIC or unwrap) to
interface (verifyMIC or unwrap) to remove the protection remove the protection and validate the data.
and validate the data.
4) At the completion of a communications session (which may 4) At the completion of a communications session (which may extend
extend across several transport connections), each across several transport connections), each application uses a
application uses a GSSContext method to invalidate the GSSContext method to invalidate the security context and
security context and release any system or cryptographic release any system or cryptographic resources held. Multiple
resources held. Multiple contexts may also be used (either contexts may also be used (either successively or
successively or simultaneously) within a single simultaneously) within a single communications association, at
communications association, at the discretion of the the discretion of the applications.
applications.
3. Additional Controls 3. 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 Delegation
The (usually temporary) transfer of rights from initiator to The (usually temporary) transfer of rights from initiator to
acceptor, enabling the acceptor to authenticate itself as an acceptor, enabling the acceptor to authenticate itself as an
agent of the initiator. agent of the initiator.
Mutual Authentication Mutual Authentication
In addition to the initiator authenticating its identity to the In addition to the initiator authenticating its identity to the
context acceptor, the context acceptor should also authenticate
GSS-API Java Bindings December 1999 itself to the initiator.
context acceptor, the context acceptor should also authenticate
itself to the initiator.
Replay Detection Replay Detection
In addition to providing message integrity services, GSSContext In addition to providing message integrity services, GSSContext
per-message operations of getMIC and wrap should include message per-message operations of getMIC and wrap should include
numbering information to enable verifyMIC and unwrap to detect message numbering information to enable verifyMIC and unwrap
if a message has been duplicated. to detect if a message has been duplicated.
Out-of-Sequence Detection Out-of-Sequence Detection
In addition to providing message integrity services, GSSContext In addition to providing message integrity services, GSSContext
per-message operations (getMIC and wrap) should include message per-message operations (getMIC and wrap) should include
sequencing information to enable verifyMIC and unwrap to detect message sequencing information to enable verifyMIC and unwrap
if a message has been received out of sequence. to detect if a message has been received out of sequence.
Anonymous Authentication Anonymous Authentication
The establishment of the security context should not reveal the The establishment of the security context should not reveal the
initiator's identity to the context acceptor. initiator's identity to the context 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
skipping to change at page 10, line 4 skipping to change at page 9, line 20
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 3.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
GSS-API Java Bindings December 1999
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
it is, the delegated credential object can be obtained by calling the it is, the delegated credential object can be obtained by calling the
getDelegCred method. The obtained GSSCredential object may then be getDelegCred method. The obtained GSSCredential object may then be
used to initiate subsequent GSS-API security contexts as an agent or used to initiate subsequent GSS-API security contexts as an agent or
delegate of the initiator. If the original initiator's identity is delegate of the initiator. If the original initiator's identity is
skipping to change at page 11, line 4 skipping to change at page 10, line 19
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
GSS-API Java Bindings December 1999
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 3.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
skipping to change at page 12, line 4 skipping to change at page 11, line 16
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 3.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
GSS-API Java Bindings December 1999
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
on mailing-lists). on mailing-lists).
In normal use of the GSS-API, the initiator's identity is made In normal use of the GSS-API, the initiator's identity is made
available to the acceptor as a result of the context establishment available to the acceptor as a result of the context establishment
process. However, context initiators may request that their identity process. However, context initiators may request that their identity
not be revealed to the context acceptor. Many mechanisms do not not be revealed to the context acceptor. Many mechanisms do not
skipping to change at page 13, line 5 skipping to change at page 12, line 16
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. Confidentiality 3.5. Confidentiality
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. MessageProp object used in the wrap method.
GSS-API Java Bindings December 1999
3.6. Inter-process Context Transfer 3.6. Inter-process Context Transfer
GSS-API V2 provides functionality which allows a security context to GSS-API V2 provides functionality which allows a security context to
be transferred between processes on a single machine. These are be 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
skipping to change at page 14, line 4 skipping to change at page 13, line 18
transferable. transferable.
3.7. The Use of Incomplete Contexts 3.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
GSS-API Java Bindings December 1999
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 4. 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 Java Cryptographic Architecture (JCA) defines a Moreover, the JCA defines a provider model which allows for
provider model which allows an implementation independent access to implementation independent access to security services. Using this
its security services. Using this model, applications can seamlessly model, applications can seamlessly switch between different
switch between different implementations and dynamically add new implementations and dynamically add new services. The GSS-API
services. The GSS-API specification leverages these concepts by the specification leverages these concepts by the usage of providers for
usage of providers for the mechanism implementations. the mechanism implementations.
4.1. Package Name 4.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 shows in section 7. of this API should import this package name as shown in section 7.
4.2. Provider Framework 4.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
provider. provider.
GSS-API Java Bindings December 1999
Using the Java security provider model insulates applications from Using the Java security provider model insulates applications from
implementation details of the services they wish to use. implementation details of the services they wish to use.
Applications can switch between providers easily and new providers Applications can switch between providers easily and new providers
can be added as needed, even at runtime. can be added as needed, even at runtime.
The GSS-API may use providers to find components for specific The GSS-API may use providers to find components for specific
underlying security mechanisms. For instance, a particular provider underlying security mechanisms. For instance, a particular provider
might contain components that will allow the GSS-API to support the might contain components that will allow the GSS-API to support the
Kerberos v5 mechanism and another might contain components to support Kerberos v5 mechanism and another might contain components to support
the SPKM mechanism. By delegating mechanism specific functionality the SPKM mechanism. By delegating mechanism specific functionality
skipping to change at page 16, line 4 skipping to change at page 15, line 10
arrays contain a length field which enables the users to easily arrays contain a length field which enables the users to easily
determine their size. The language has automatic garbage collection determine their size. The language has automatic garbage collection
which alleviates the need by developers to release memory and which alleviates the need by developers to release memory and
simplifies buffer ownership issues. simplifies buffer ownership issues.
4.5. Strings 4.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
GSS-API Java Bindings December 1999
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 4.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
skipping to change at page 16, line 34 skipping to change at page 15, line 37
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 4.7. Object Identifier Sets
The Java bindings represents object identifiers sets as arrays of Oid The Java bindings represents object identifiers 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 2078, the Oid class In order to support the full functionality of RFC 2743, the Oid class
includes a method which checks for existence of an Oid object within includes a method which checks for existence of an Oid object within
a specified array. This is equivalent in functionality to a specified array. This is equivalent in functionality to
gss_test_oid_set_member. The use of Java arrays and Java's automatic gss_test_oid_set_member. The use of Java arrays and Java's automatic
garbage collection has eliminated the need for the following garbage collection has eliminated the need for the following
routines: gss_create_empty_oid_set, gss_release_oid_set, and routines: gss_create_empty_oid_set, gss_release_oid_set, and
gss_add_oid_set_member. Java GSS-API implementations will not 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 complicated memory property of the Oid object eliminates the complicated memory
management issues of the C counterpart. management issues of the C counterpart.
When ever a default value for an Object Identifier Set is required, a When ever 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 4.8. Credentials
GSS-API credentials are represented by the GSSCredential interface. GSS-API credentials are represented by the GSSCredential interface.
GSS-API Java Bindings December 1999
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 is authentication data for multiple mechanisms. A GSS-API credential is
composed of a set of credential-elements, each of which is applicable composed of a set of credential-elements, each of which is applicable
to a single mechanism. A credential may contain at most one to a single mechanism. A credential may contain at most one
credential-element for each supported mechanism. A credential- credential-element for each supported mechanism. A credential-
element identifies the data needed by a single mechanism to element identifies the data needed by a single mechanism to
authenticate a single principal, and conceptually contains two authenticate a single principal, and conceptually contains two
credential-references that describe the actual mechanism-specific credential-references that describe the actual mechanism-specific
authentication data, one to be used by GSS-API for initiating authentication data, one to be used by GSS-API for initiating
contexts, and one to be used for accepting contexts. For mechanisms contexts, and one to be used for accepting contexts. For mechanisms
that do not distinguish between acceptor and initiator credentials, that do not distinguish between acceptor and initiator credentials,
both references would point to the same underlying mechanism-specific both references would point to the same underlying mechanism-specific
authentication data. 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's of an GSSContext object allows the value of "null" to The creation's of an GSSContext object allows the value of "null" to
be specified as the GSSCredential input parameter. This will be specified as the GSSCredential input parameter. This will
indicate a desire by the application to act as a default principal. indicate a desire by the application to act as a default principal.
While individual GSS-API implementations are free to determine such While 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: default 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 contexts for the chosen mechanism that the
application is authorized to act on behalf of, then that
principal shall be used, otherwise
2) If the platform maintains a concept of a default network-
identity for the chosen mechanism, and if the application
is authorized to act on behalf of that identity for the
purpose of initiating security contexts, then the principal
corresponding to that identity shall be used, otherwise
3) If the platform maintains a concept of a default local 1) If there is only a single principal capable of initiating
security contexts for the chosen mechanism that the application
is authorized to act on behalf of, then that principal shall be
used, otherwise
GSS-API Java Bindings December 1999 2) If the platform maintains a concept of a default network-
identity for the chosen mechanism, and if the application is
authorized to act on behalf of that identity for the purpose of
initiating security contexts, then the principal corresponding
to that identity shall be used, otherwise
identity, and provides a means to map local identities into 3) If the platform maintains a concept of a default local
network-identities for the chosen mechanism, and if the identity, and provides a means to map local identities into
application is authorized to act on behalf of the network- network-identities for the chosen mechanism, and if the
identity image of the default local identity for the application is authorized to act on behalf of the network-
purpose of initiating security contexts using the chosen identity image of the default local identity for the purpose of
mechanism, then the principal corresponding to that initiating security contexts using the chosen mechanism, then
identity shall be used, otherwise the principal corresponding to that identity shall be used,
otherwise
4) A user-configurable default identity should be used. 4) A user-configurable default identity should be used.
and for the acceptor side of the context and for the acceptor side of the context
1) If there is only a single authorized principal identity 1) If there is only a single authorized principal identity capable
capable of accepting security contexts for the chosen of accepting security contexts for the chosen mechanism, then
mechanism, then that principal shall be used, otherwise that principal shall be used, otherwise
2) If the mechanism can determine the identity of the target 2) If the mechanism can determine the identity of the target
principal by examining the context-establishment token principal by examining the context-establishment token
processed during the accept method, and if the accepting processed during the accept method, and if the accepting
application is authorized to act as that principal for the application is authorized to act as that principal for the
purpose of accepting security contexts using the chosen purpose of accepting security contexts using the chosen
mechanism, then that principal identity shall be used, mechanism, then that principal identity shall be used,
otherwise otherwise
3) If the mechanism supports context acceptance by any 3) If the mechanism supports context acceptance by any principal,
principal, and if mutual authentication was not requested, and if mutual authentication was not requested, any principal
any principal that the application is authorized to accept that the application is authorized to accept security contexts
security contexts under using the chosen mechanism may be under using the chosen mechanism may be used, otherwise
used, otherwise
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 4.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.
GSS-API Java Bindings December 1999
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 which will the initiator may choose to set various context options which 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
skipping to change at page 20, line 4 skipping to change at page 19, line 7
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 interprocess tokens, or to sensitive information within interprocess 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 interprocess It is the application's responsibility to ensure that interprocess
tokens are protected in transit, and transferred only to processes tokens are protected in transit, and transferred only to processes
that are trustworthy. An interprocess token is represented using a that are trustworthy. An interprocess 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 interprocess token would initialize interface. The receiver of the interprocess token would initialize
GSS-API Java Bindings December 1999
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 4.12. Error Reporting
RFC 2078 defined the usage of major and minor status values for RFC 2743 defined the usage of major and minor status values for
signaling of GSS-API errors. The major code, also called GSS status signaling of GSS-API errors. The major code, also called GSS status
code, is used to signal errors at the GSS-API level independent of code, is used to signal errors at the GSS-API level independent of
the underlying mechanism(s). The minor status value or Mechanism the underlying mechanism(s). The minor status value or Mechanism
status code, is a mechanism defined error value indicating a status code, is a mechanism defined error value indicating a
mechanism specific error code. 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. GSSException class also minor codes to be used within the API calls. GSSException class also
contains methods to obtain textual representations for both the major contains methods to obtain textual representations for both the major
and minor values, which is equivalent to the functionality of and minor values, which is equivalent to the functionality of
gss_display_status. gss_display_status.
4.12.1. GSS status codes 4.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
skipping to change at page 21, line 4 skipping to change at page 20, line 8
need to be handled as return values since using exceptions is not need to be handled as return values since using exceptions is not
appropriate for informatory or warning-like information. The methods appropriate for informatory or warning-like information. The methods
that are capable of producing supplementary information are the two that are capable of producing supplementary information are the two
per-message methods GSSContext.verifyMIC() and GSSContext.unwrap(). per-message methods GSSContext.verifyMIC() and GSSContext.unwrap().
These methods fill the supplementary status codes in the MessageProp These methods fill the supplementary status codes in the MessageProp
object that was passed in. object that was passed in.
GSSException object, along with providing the functionality for GSSException object, along with providing the functionality for
setting of the various error codes and translating them into textual setting of the various error codes and translating them into textual
representation, also contains the definitions of all the numeric representation, also contains the definitions of all the numeric
GSS-API Java Bindings December 1999
error values. The following table lists the definitions of error error values. The following table lists the definitions of error
codes: codes:
Table: GSS Status Codes Table: GSS Status Codes
Name Value Meaning
BAD_MECH 1 An unsupported mechanism
was requested.
BAD_NAME 2 An invalid name was supplied. Name Value Meaning
BAD_NAMETYPE 3 A supplied name was of an BAD_MECH 1 An unsupported mechanism
unsupported type. was requested.
BAD_BINDINGS 4 Incorrect channel bindings were BAD_NAME 2 An invalid name was supplied.
supplied.
BAD_STATUS 5 An invalid status code was BAD_NAMETYPE 3 A supplied name was of an
supplied. unsupported type.
BAD_MIC 6 A token had an invalid MIC. BAD_BINDINGS 4 Incorrect channel bindings were
supplied.
NO_CRED 7 No credentials were supplied, or BAD_STATUS 5 An invalid status code was
the credentials were unavailable supplied.
or inaccessible.
NO_CONTEXT 8 Invalid context has been BAD_MIC 6 A token had an invalid MIC.
supplied.
DEFECTIVE_TOKEN 9 A supplied token was invalid. NO_CRED 7 No credentials were supplied, or
the credentials were unavailable
or inaccessible.
DEFECTIVE_CREDENTIAL 10 A supplied credential was NO_CONTEXT 8 Invalid context has been
invalid. supplied.
CREDENTIALS_EXPIRED 11 The referenced credentials DEFECTIVE_TOKEN 9 A supplied token was invalid.
have expired.
CONTEXT_EXPIRED 12 The context has expired. DEFECTIVE_CREDENTIAL 10 A supplied credential was
invalid.
FAILURE 13 Miscellaneous failure, CREDENTIALS_EXPIRED 11 The referenced credentials
unspecified at the GSS-API level. have expired.
BAD_QOP 14 The quality-of-protection CONTEXT_EXPIRED 12 The context has expired.
requested could not be provided.
UNAUTHORIZED 15 The operation is forbidden by FAILURE 13 Miscellaneous failure,
unspecified at the GSS-API level.
GSS-API Java Bindings December 1999 BAD_QOP 14 The quality-of-protection
requested could not be provided.
local security policy. UNAUTHORIZED 15 The operation is forbidden by
local security policy.
UNAVAILABLE 16 The operation or option is UNAVAILABLE 16 The operation or option is
unavailable. unavailable.
DUPLICATE_ELEMENT 17 The requested credential DUPLICATE_ELEMENT 17 The requested credential
element already exists. element already exists.
NAME_NOT_MN 18 The provided name was not a NAME_NOT_MN 18 The provided name was not a
mechanism name. mechanism name.
OLD_TOKEN 19 The token's validity period has OLD_TOKEN 19 The token's validity period has
expired. expired.
DUPLICATE_TOKEN 20 The token was a duplicate of an DUPLICATE_TOKEN 20 The token was a duplicate of an
earlier version. earlier version.
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 2078 [GSSAPIv2]. calls in RFC 2743 [GSSAPIv2-UPDATE].
4.12.2. Mechanism-specific status codes 4.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 4.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.
GSS-API Java Bindings December 1999
The MessageProp class defines query methods which return boolean The MessageProp class defines query methods which return boolean
values indicating the following supplementary states: values indicating the following supplementary states:
Table: Supplementary Status Methods Table: Supplementary Status Methods
Method Name Meaning when "true" is returned Method Name Meaning when "true" is returned
isDuplicateToken The token was a duplicate of an isDuplicateToken The token was a duplicate of an
earlier token. earlier token.
isOldToken The token's validity period has isOldToken The token's validity period has
expired. expired.
isUnseqToken A later token has already been isUnseqToken A later token has already been
processed. processed.
isGapToken An expected per-message token was isGapToken An expected per-message token was
not received. not received.
"true" return value for any of the above methods indicates that the "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 4.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 interface: A single GSSName object may contain multiple names from
from different namespaces, but all names should refer to the different namespaces, but all names should refer to the same
same entity. An example of such an internal name would be the entity. An example of such an internal name would be the name
name returned from a call to the getName method of the returned from a call to the getName method of the GSSCredential
GSSCredential interface, when applied to a credential containing interface, when applied to a credential containing credential
credential elements for multiple authentication mechanisms elements for multiple authentication mechanisms employing
employing different namespaces. This GSSName object will different namespaces. This GSSName object will contain a distinct
name for the entity for each authentication mechanism.
GSS-API Java Bindings December 1999
contain a distinct 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 calling applications and name types. These formats are capable of
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, identifier specifying the namespace to which the name belongs, and
and their format is dependent on the authentication mechanism their format is dependent on the authentication mechanism that
that employs that name. The string name forms are assumed to be employs that name. The string name forms are assumed to be
printable, and may therefore be used by GSS-API applications for printable, and may therefore be used by GSS-API applications for
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).
An 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
skipping to change at page 24, line 53 skipping to change at page 23, line 48
journey through the internal name-form. An example of this might be journey through the internal name-form. An example of this might be
a mechanism that authenticates X.500 names, but provides an a mechanism that authenticates X.500 names, but provides an
algorithmic mapping of Internet DNS names into X.500. That algorithmic mapping of Internet DNS names into X.500. That
mechanism's implementation of GSSName might, when presented with a mechanism's implementation of GSSName might, when presented with a
DNS name, generate an internal name that contained both the original DNS name, generate an internal name that contained both the original
DNS name and the equivalent X.500 name. Alternatively, it might only DNS name and the equivalent X.500 name. Alternatively, it might only
store the X.500 name. In the latter case, the toString method of store the X.500 name. In the latter case, the toString method of
GSSName would most likely generate a printable X.500 name, rather GSSName would most likely generate a printable X.500 name, rather
than the original DNS name. than the original DNS name.
The context acceptor can obtain an GSSName object representing the The context acceptor can obtain a GSSName object representing the
entity performing the context initiation (through the usage of entity performing the context initiation (through the usage of
GSS-API Java Bindings December 1999
getSrcName method). Since this name has been authenticated by a getSrcName method). Since this name has been authenticated by a
single mechanism, it contains only a single name (even if the single mechanism, it contains only a single name (even if the
internal name presented by the context initiator to the GSSContext internal name presented by the context initiator to the GSSContext
object had multiple components). Such names are termed internal object had multiple components). Such names are termed internal
mechanism names, or "MN"s and the names emitted by GSSContext mechanism names, or "MN"s and the names emitted by GSSContext
interface in the getSrcName and getTargName are always of this type. interface in the getSrcName and getTargName are always of this type.
Since some applications may require MNs without wanting to incur the Since some applications may require MNs without wanting to incur the
overhead of an authentication operation, creation methods are overhead of an authentication operation, creation methods are
provided that take not only the name buffer and name type, but also provided that take not only the name buffer and name type, but also
the mechanism oid for which this name should be created. When the mechanism oid for which this name should be created. When
skipping to change at page 25, line 48 skipping to change at page 24, line 42
export method. Exported names may be re-imported by using the byte export method. Exported names may be re-imported by using the byte
array constructor and specifying the NT_EXPORT_NAME as the name type array constructor and specifying the NT_EXPORT_NAME as the name type
object identifier. The resulting GSSName name will also be a MN. object identifier. The resulting 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
specified in the language-independent GSS-API specification specified in the language-independent GSS-API specification
[GSSAPIv2]. [GSSAPIv2-UPDATE].
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
GSS-API Java Bindings December 1999
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 how GSSName It is important to note that the above are guidelines as how GSSName
implementations should behave, and are not intended to be specific implementations should behave, and are not intended to be specific
requirements of how names objects must be implemented. The mechanism requirements of how names objects must be implemented. The mechanism
designers are free to decide on the details of their implementations designers are free to decide on the details of their implementations
of the GSSName interface as long as the behavior satisfies the above of the GSSName interface as long as the behavior satisfies the above
guidelines. guidelines.
skipping to change at page 26, line 30 skipping to change at page 25, line 25
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 an 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
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 specific data. application specific data.
Conceptually, the GSS-API concatenates the initiator and acceptor Conceptually, the GSS-API concatenates the initiator and acceptor
address information, and the application supplied byte array to form address information, and the application supplied byte array to form
an octet string. The mechanism calculates a MIC over this octet an octet string. The mechanism calculates a MIC over this octet
string and binds the MIC to the context establishment token emitted string and binds the MIC to the context establishment token emitted
skipping to change at page 27, line 4 skipping to change at page 25, line 49
The calculated MIC is compared with that found in the token, and if The calculated MIC is compared with that found in the token, and if
the MICs differ, accept will throw a GSSException with the major the MICs differ, accept will throw a GSSException with the major
code set to BAD_BINDINGS, and the context will not be established. code set to BAD_BINDINGS, and the context will not be established.
Some mechanisms may include the actual channel binding data in the Some mechanisms may include the actual channel binding data in the
token (rather than just a MIC); applications should therefore not use token (rather than just a MIC); applications should therefore not use
confidential data as channel-binding components. confidential data as channel-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
GSS-API Java Bindings December 1999
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 setting of the addressing information for the address fields, or omit setting of the addressing
information. information.
4.15. Stream Objects 4.15. Stream Objects
The context object provides overloaded methods which use input and The context object provides overloaded methods which use input and
output streams as the means to convey authentication and per-message output streams as the means to convey authentication and per-message
GSS-API tokens. It is important to note that the streams are GSS-API tokens. It is important to note that the streams are
skipping to change at page 27, line 48 skipping to change at page 26, line 41
5. Introduction to GSS-API Classes and Interfaces 5. 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 API's then these classes will GSS becomes part of the standard Java API's 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 2078 functionality This section also shows the corresponding RFC 2743 functionality
implemented by each of the classes. Detailed description of these implemented by each of the classes. Detailed description of these
GSS-API Java Bindings December 1999
classes and their methods is presented in section 6. classes and their methods is presented in section 6.
5.1. GSSManager class 5.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 2078 routines: This class contains equivalents of the following RFC 2743 routines:
RFC 2078 Routine Function Section
gss_import_name Create an internal name from 6.1.9- gss_import_name Create an internal name from 6.1.9-
the supplied information. 6.1.12 the supplied information. 6.1.12
gss_acquire_cred Acquire credential 6.1.13- gss_acquire_cred Acquire credential 6.1.13-
for use. 6.1.15 for use. 6.1.15
gss_import_sec_context Create a previously exported 6.1.18 gss_import_sec_context Create a previously exported 6.1.18
context. context.
skipping to change at page 29, line 4 skipping to change at page 27, line 38
gss_inquire_names_for_mech List the name types 6.1.7 gss_inquire_names_for_mech List the name types 6.1.7
supported by the supported by the
specified mechanism. specified mechanism.
5.2. GSSName interface 5.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
GSS-API Java Bindings December 1999
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 2078 Routine Function Section(s) RFC 2743 Routine Function Section(s)
gss_display_name Covert internal name 6.2.7 gss_display_name Covert internal name 6.2.7
representation to text format. representation to text format.
gss_compare_name Compare two internal names. 6.2.3, 6.2.4 gss_compare_name Compare two internal names. 6.2.3, 6.2.4
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 a 6.1.11, gss_canonicalize_name Convert an internal name to a 6.1.11,
skipping to change at page 29, line 44 skipping to change at page 28, line 29
5.3. GSSCredential interface 5.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 2078 Routine Function Section(s) RFC 2743 Routine Function Section(s)
gss_add_cred Constructs credentials 6.3.12 gss_add_cred Constructs credentials 6.3.12
incrementally. incrementally.
gss_inquire_cred Obtain information about 6.3.4,6.3.5 gss_inquire_cred Obtain information about 6.3.4,6.3.5
GSS-API Java Bindings December 1999
credential. credential.
gss_inquire_cred_by_mech Obtain per-mechanism 6.3.5-6.3.10 gss_inquire_cred_by_mech Obtain per-mechanism 6.3.5-6.3.10
information about information about
a credential. a credential.
gss_release_cred Disposes of credentials 6.3.3 gss_release_cred Disposes of credentials 6.3.3
after use. after use.
5.4. GSSContext interface 5.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 2078 Routine Function Section(s) RFC 2743 Routine Function Section(s)
gss_init_sec_context Initiate the creation of a 6.4.3, gss_init_sec_context Initiate the creation of a 6.4.3,
security context with a peer. 6.4.4 security context with a peer. 6.4.4
gss_accept_sec_context Accept a security context 6.4.5, gss_accept_sec_context Accept a security context 6.4.5,
initiated by a peer. 6.4.6 initiated by a peer. 6.4.6
gss_delete_sec_context Destroy a security context. 6.4.8 gss_delete_sec_context Destroy a security context. 6.4.8
gss_context_time Obtain remaining context 6.4.37 gss_context_time Obtain remaining context 6.4.37
skipping to change at page 31, line 4 skipping to change at page 29, line 32
characteristics. 6.3.42 characteristics. 6.3.42
gss_wrap_size_limit Determine token-size limit 6.4.9 gss_wrap_size_limit Determine token-size limit 6.4.9
for gss_wrap. for gss_wrap.
gss_export_sec_context Transfer security context 6.4.18 gss_export_sec_context Transfer security context 6.4.18
to another process. to another process.
gss_get_mic Calculate a cryptographic 6.4.14, gss_get_mic Calculate a cryptographic 6.4.14,
Message Integrity Code (MIC) 6.4.15 Message Integrity Code (MIC) 6.4.15
GSS-API Java Bindings December 1999
for a message. for a message.
gss_verify_mic Verify integrity on a received 6.4.16, gss_verify_mic Verify integrity on a received 6.4.16,
message. 6.4.17 message. 6.4.17
gss_wrap Attach a MIC to a message and 6.4.10, gss_wrap Attach a MIC to a message and 6.4.10,
optionally encrypt the message 6.4.11 optionally encrypt the message 6.4.11
content. content.
gss_unwrap Obtain a previously wrapped 6.4.12, gss_unwrap Obtain a previously wrapped 6.4.12,
application message verifying 6.4.13 application message verifying 6.4.13
its integrity and optionally its integrity and optionally
decrypting it. 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 the RFC 2078 update accordance to the recommendations stated in RFC 2743. GSSContext
draft. GSSContext does offer the functionality of destroying the does offer the functionality of destroying the locally-stored context
locally-stored context information. information.
5.5. MessageProp class 5.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
skipping to change at page 31, line 49 skipping to change at page 30, line 28
5.6. GSSException class 5.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 2078 Routine Function Section RFC 2743 Routine Function Section
GSS-API Java Bindings December 1999
gss_display_status Retrieve textual 6.8.5, 6.8.6, gss_display_status Retrieve textual 6.8.5, 6.8.6,
representation of error 6.8.8, 6.8.9 representation of error 6.8.8, 6.8.9
codes. codes.
5.7. Oid class 5.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 2078 Routine Function Section RFC 2743 Routine Function Section
gss_test_oid_set_member Determine if the specified oid 6.7.5 gss_test_oid_set_member Determine if the specified oid 6.7.5
is part of a set of oids. is part of a set of oids.
5.8. ChannelBinding class 5.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
skipping to change at page 33, line 4 skipping to change at page 31, line 29
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 6.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 nametypes these are available from the GSS implementation and what nametypes these
mechanisms support. An instance of the default GSSManager subclass mechanisms support. An instance of the default GSSManager subclass
GSS-API Java Bindings December 1999
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
skipping to change at page 33, line 33 skipping to change at page 32, line 8
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 of supported. Applications that expect to be portable should be aware of
this and recover cleanly by catching the exception. 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 1) The application does not care about what provider is used (the
(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 preferentially, either for a particular mechanism or all the
the time, irrespective of mechanism. time, irrespective of mechanism.
3) The application wants to use the locally configured 3) The application wants to use the locally configured providers
providers as far as possible but if support is missing for as far as possible but if support is missing for one or more
one or more mechanisms then it wants to fall back on its mechanisms then it wants to fall back on its own provider.
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 is service provider specification the GSSManager subclass follows. It is
hoped that these methods will serve the needs of most applications. hoped that these methods will serve the needs of most applications.
Additional methods may be added to an extended GSSManager that could Additional methods may be added to an extended GSSManager that could
be part of a service provider specification that is standardized be part of a service provider specification that is standardized
GSS-API Java Bindings December 1999
later. later.
6.1.1. Example Code 6.1.1. Example Code
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 is need // Set a preference for the provider to be used when support is needed
// for the mechanisms "1.2.840.113554.1.2.2" and "1.3.6.1.5.5.1.1". // for the mechanisms "1.2.840.113554.1.2.2" and "1.3.6.1.5.5.1.1".
Oid krb = new Oid("1.2.840.113554.1.2.2"); Oid krb = new Oid("1.2.840.113554.1.2.2");
Oid spkm1 = new Oid("1.3.6.1.5.5.1.1"); Oid spkm1 = new Oid("1.3.6.1.5.5.1.1");
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);
6.1.2. getInstance 6.1.2. getInstance
public static GSSManager getInstance() public static GSSManager getInstance()
Returns the default GSSManager implemenation. Returns the default GSSManager implementation.
6.1.3. getMechs 6.1.3. getMechs
public abstract Oid[] getMechs() public abstract Oid[] getMechs()
Returns an array of Oid objects indicating mechanisms available to Returns an array of Oid objects indicating mechanisms available to
GSS-API callers. A "null" value is returned when no mechanism are 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.4. getNamesForMech 6.1.4. getNamesForMech
public abstract Oid[] getNamesForMech(Oid mech) public abstract Oid[] getNamesForMech(Oid mech)
throws GSSException
GSS-API Java Bindings December 1999
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.5. getMechsForName 6.1.5. 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 support the specific name type. "null" is returned when no
mechanisms are found to support the specified name type. mechanisms 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.6. createName 6.1.6. createName
public abstract GSSName createName(String nameStr, Oid nameSpace) 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 an 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.
Parameters: Parameters:
nameStr The string representing a printable form of the name nameStr The string representing a printable form of the name
to create. to create.
nameType The Oid specifying the namespace of the printable name
supplied. Note that nameType serves to describe and
qualify the interpretation of the input nameStr, it
does not necessarily imply a type for the output
GSSName implementation. "null" value can be used to
specify that a mechanism specific default printable
syntax should be assumed by each mechanism that
examines nameStr.
GSS-API Java Bindings December 1999 nameType The Oid specifying the namespace of the printable name
supplied. Note that nameType serves to describe and
qualify the interpretation of the input nameStr, it
does not necessarily imply a type for the output
GSSName implementation. "null" value can be used to
specify that a mechanism specific default printable
syntax should be assumed by each mechanism that
examines nameStr.
6.1.7. createName 6.1.7. 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 an 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.
Parameters: Parameters:
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 supplied nameType The Oid specifying the namespace of the name supplied
in the byte array. Note that nameType serves to in the byte array. Note that nameType serves to
describe and qualify the interpretation of the input describe and qualify the interpretation of the input
name byte array, it does not necessarily imply a type name byte array, it does not necessarily imply a type
for the output GSSName implementation. "null" value for the output GSSName implementation. "null" value
can be used to specify that a mechanism specific can be used to specify that a mechanism specific
default syntax should be assumed by each mechanism default syntax should be assumed by each mechanism
that examines the byte array. that examines the byte array.
6.1.8. createName 6.1.8. createName
public abstract GSSName createName(String nameStr, Oid nameType, public abstract GSSName createName(String nameStr, Oid nameType,
Oid mechType) 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 an GSSName object that is a mechanism name (MN). In namespace to an 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 6.1.7 and then also the steps: the createName described in 6.1.7 and then also the
GSSName.canonicalize() described in 6.2.5. GSSName.canonicalize() described in 6.2.5.
Parameters: Parameters:
nameStr The string representing a printable form of the name nameStr The string representing a printable form of the name
to create. to create.
nameType The Oid specifying the namespace of the printable name
supplied. Note that nameType serves to describe and
qualify the interpretation of the input nameStr, it
does not necessarily imply a type for the output
GSSName implementation. "null" value can be used to
GSS-API Java Bindings December 1999
specify that a mechanism specific default printable nameType The Oid specifying the namespace of the printable name
syntax should be assumed when the mechanism examines supplied. Note that nameType serves to describe and
nameStr. qualify the interpretation of the input nameStr, it
does not necessarily imply a type for the output
GSSName implementation. "null" value can be used to
specify that a mechanism specific default printable
syntax should be assumed when the mechanism examines
nameStr.
mechType 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. createName 6.1.9. createName
public abstract createName(byte name[], Oid nameType, Oid mechType) public abstract createName(byte name[], Oid nameType, Oid mech)
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 an 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 6.1.8 and then also the steps: the createName described in 6.1.8 and then also the
GSSName.canonicalize() described in 6.2.5. GSSName.canonicalize() described in 6.2.5.
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 supplied nameType The Oid specifying the namespace of the name supplied
in the byte array. Note that nameType serves to in the byte array. Note that nameType serves to
describe and qualify the interpretation of the input describe and qualify the interpretation of the input
name byte array, it does not necessarily imply a type name byte array, it does not necessarily imply a type
for the output GSSName implementation. "null" value for the output GSSName implementation. "null" value
can be used to specify that a mechanism specific can be used to specify that a mechanism specific
default syntax should be assumed by each mechanism default syntax should be assumed by each mechanism
that examines the byte array. that examines the byte array.
mechType 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.10. createCredential 6.1.10. 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 an INDEFINITE lifetime. mechanisms, name, and a DEFAULT lifetime.
Parameters: Parameters:
usage The intended usage for this credential object. The usage The intended usage for this credential object. The
value of this parameter must be one of:
GSS-API Java Bindings December 1999 GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
value of this parameter must be one of:
GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
6.1.11. createCredential 6.1.11. createCredential
public abstract GSSCredential createCredential (GSSName aName, public abstract GSSCredential createCredential (GSSName aName,
int lifetime, Oid mechOid, 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 to aName Name of the principal for whom this credential is to
be acquired. Use "null" to specify the default be acquired. Use "null" to specify the default
principal. principal.
lifetime The number of seconds that credentials should remain lifetime The number of seconds that credentials should remain
valid. Use GSSCredential.INDEFINITE to request that valid. Use GSSCredential.INDEFINITE_LIFETIME to
the credentials have the maximum permitted lifetime. request that the credentials have the maximum
permitted lifetime. Use
GSSCredential.DEFAULT_LIFETIME to request default
credential lifetime.
mechOid The oid of the desired mechanism. Use "(Oid) null" to mech The oid of the desired mechanism. Use "(Oid) null" to
request the default mechanism(s). request the default mechanism(s).
usage The intended usage for this credential object. The usage The intended usage for this credential object. The
value of this parameter must be one of: value of this parameter must be one of:
GSSCredential.ACCEPT_AND_INITIATE, GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
6.1.12. createCredential 6.1.12. 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.
Parameters: Parameters:
aName Name of the principal for whom this credential is to aName Name of the principal for whom this credential is to
be acquired. Use "null" to specify the default be acquired. Use "null" to specify the default
principal.
GSS-API Java Bindings December 1999
principal.
lifetime The number of seconds that credentials should remain lifetime The number of seconds that credentials should remain
valid. Use GSSCredential.INDEFINITE to request that valid. Use GSSCredential.INDEFINITE_LIFETIME to
the credentials have the maximum permitted lifetime. request that the credentials have the maximum
permitted lifetime. Use
GSSCredential.DEFAULT_LIFETIME to request default
credential lifetime.
mechOid The array of mechanisms over which the credential is mechs The array of mechanisms over which the credential is
to be acquired. Use "(Oid[]) null" for requesting a to be acquired. Use "(Oid[]) null" for requesting a
system specific default set of mechanisms. system specific default set of mechanisms.
usage The intended usage for this credential object. The usage The intended usage for this credential object. The
value of this parameter must be one of: value of this parameter must be one of:
GSSCredential.ACCEPT_AND_INITIATE, GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
6.1.13. createContext 6.1.13. createContext
public abstract GSSContext createContext(GSSName peer, Oid mechOid, 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:
peer Name of the target peer. peer Name of the target peer.
mechOid Oid of the desired mechanism. Use "(Oid) null" to mech Oid of the desired mechanism. Use "(Oid) null" to
request default mechanism. request default mechanism.
myCred Credentials of the initiator. Use "null" to act as a myCred Credentials of the initiator. Use "null" to act as a
default initiator principal. default initiator principal.
lifetime The request lifetime, in seconds, for the credential. lifetime The request lifetime, in seconds, for the context.
Use GSSContext.INDEFINITE_LIFETIME and
GSSContext.DEFAULT_LIFETIME to request indefinite or
default context lifetime.
6.1.14. createContext 6.1.14. 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.
GSS-API Java Bindings December 1999
Parameters: Parameters:
myCred Credentials for the acceptor. Use "null" to act as a myCred Credentials for the acceptor. Use "null" to act as a
default acceptor principal. default acceptor principal.
6.1.15. createContext 6.1.15. createContext
public abstract GSSContext createContext(byte [] interProcessToken) public abstract GSSContext createContext(byte [] interProcessToken)
throws GSSException throws GSSException
Factory method for creating a previously exported context. The Factory method for creating 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 interProcessToken
The token previously emitted from the export method. The token previously emitted from the export method.
6.1.16. addProviderAtFront 6.1.16. 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
skipping to change at page 41, line 4 skipping to change at page 39, line 27
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
GSS-API Java Bindings December 1999
operation is unavailable. operation is unavailable.
Parameters: Parameters:
p The provider instance that should be used whenever p The provider instance that should be used whenever
support is needed for mech. support is needed for mech.
mech The mechanism for which the provider is being set mech The mechanism for which the provider is being set
6.1.16.1. Example Code 6.1.16.1. 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:
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 5 skipping to change at page 40, line 25
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), becomes {(B, null), (A, null),
... //followed by the pre-configured list. ... //followed by the pre-configured list.
Please note, however, that the following call: Please note, however, that the following call:
mgr.addProviderAtFront(A, m3) mgr.addProviderAtFront(A, m3)
GSS-API Java Bindings December 1999
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.17. addProviderAtEnd 6.1.17. addProviderAtEnd
public abstract addProviderAtEnd(Provider p, Oid mech) public abstract 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
skipping to change at page 42, line 37 skipping to change at page 41, line 7
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 whenever p The provider instance that should be used whenever
support is needed for mech. support is needed for mech.
mech The mechanism for which the provider is being set mech The mechanism for which the provider is being set
6.1.17.1. Example Code 6.1.17.1. 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 only needed the system default providers always be checked first, and only
when they do not support m1 should a provider A be checked. It would when they do not support m1 should a provider A be checked. It would
then make the call: then make the call:
GSSManager mgr = GSSManager.getInstance(); GSSManager mgr = GSSManager.getInstance();
mgr.addProviderAtEnd(A, m1); mgr.addProviderAtEnd(A, m1);
GSS-API Java Bindings December 1999
Now, if it also desired that for all mechanisms the provider B be Now, if it also desired that for all mechanisms the provider B be
checked after all configured providers have been checked, it would checked after all configured providers have been checked, it would
then call: then call:
mgr.addProviderAtEnd(B, null); mgr.addProviderAtEnd(B, null);
Effectively the list of preferences now becomes {..., (A, m1), (B, Effectively the list of preferences now becomes {..., (A, m1), (B,
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
skipping to change at page 43, line 47 skipping to change at page 42, line 19
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. Example Code 6.2.1. 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.
GSSManager mgr = new GSSManager(); GSSManager mgr = GSSManager.getInstance();
// create a host based service name // create a host based service name
GSSName name = mgr.createName("service@host", GSSName name = mgr.createName("service@host",
GSS-API Java Bindings December 1999
GSSName.NT_HOSTBASED_SERVICE); GSSName.NT_HOSTBASED_SERVICE);
Oid krb5 = new Oid("1.2.840.113554.1.2.2"); Oid krb5 = new Oid("1.2.840.113554.1.2.2");
GSSName mechName = name.canonicalize(krb5); GSSName mechName = name.canonicalize(krb5);
// the above two steps are equivalent to the following // the above two steps are equivalent to the following
GSSName mechName = mgr.createName("service@host", GSSName mechName = mgr.createName("service@host",
GSSName.NT_HOSTBASED_SERVICE, krb5); GSSName.NT_HOSTBASED_SERVICE, krb5);
skipping to change at page 45, line 5 skipping to change at page 43, line 25
Values for the "service" element are registered with the IANA. It Values for the "service" element are registered with the IANA. It
represents the following value: { 1(iso), 3(org), 6(dod), represents the following value: { 1(iso), 3(org), 6(dod),
1(internet), 5(security), 6(nametypes), 2(gss-host-based-services) } 1(internet), 5(security), 6(nametypes), 2(gss-host-based-services) }
public static final Oid NT_USER_NAME public static final Oid NT_USER_NAME
Name type to indicate a named user on a local system. It represents Name type to indicate a named user on a local system. It represents
the following value: { iso(1) member-body(2) United States(840) the following value: { iso(1) member-body(2) United States(840)
mit(113554) infosys(1) gssapi(2) generic(1) user_name(1) } mit(113554) infosys(1) gssapi(2) generic(1) user_name(1) }
GSS-API Java Bindings December 1999
public static final Oid NT_MACHINE_UID_NAME public static final Oid NT_MACHINE_UID_NAME
Name type to indicate a numeric user identifier corresponding to a Name type to indicate a numeric user identifier corresponding to a
user on a local system. (e.g. Uid). It represents the following user on a local system. (e.g. Uid). It represents the following
value: { iso(1) member-body(2) United States(840) mit(113554) value: { iso(1) member-body(2) United States(840) mit(113554)
infosys(1) gssapi(2) generic(1) machine_uid_name(2) } infosys(1) gssapi(2) generic(1) machine_uid_name(2) }
public static final Oid NT_STRING_UID_NAME public static final Oid NT_STRING_UID_NAME
Name type to indicate a string of digits representing the numeric Name type to indicate a string of digits representing the numeric
skipping to change at page 45, line 44 skipping to change at page 44, line 16
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 to compare with. another GSSName object to compare with.
6.2.4. equals 6.2.4. equals
public boolean equals(Object another) public boolean equals(Object another)
GSS-API Java Bindings December 1999
A variation of the equals method described in 6.2.3 that is provided A variation of the equals method described in 6.2.3 that is provided
to override the Object.equals() method that the implementing class to override the Object.equals() method that the implementing class
will inherit. The behaviour is exactly the same as that in 6.2.3 will inherit. The behavior is exactly the same as that in 6.2.3
except that no GSSException is thrown; instead, false will be except that no GSSException is thrown; instead, false will be
returned in the situation where an error occurs. (Note that the Java returned in the situation where an error occurs. (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:
another GSSName object to compare with. another GSSName object to compare with.
6.2.5. canonicalize 6.2.5. canonicalize
public GSSName canonicalize(Oid mechOid) 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 6.1.9 or is equivalent to using the factory methods described in 6.1.9 or
6.1.10 that take the mechanism name as one of their parameters. 6.1.10 that take the mechanism name as one of their parameters.
Parameters: Parameters:
mechOid The oid for the mechanism for which the canonical form mech The oid for the mechanism for which the canonical form
of the name is requested. of the name is requested.
6.2.6. export 6.2.6. 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 2078. specified in RFC 2743.
6.2.7. toString 6.2.7. 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
GSS-API Java Bindings December 1999
string, the getStringNameType method can be used. string, the getStringNameType method can be used.
6.2.8. getStringNameType 6.2.8. 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.
skipping to change at page 47, line 29 skipping to change at page 45, line 46
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.10. isMN 6.2.10. 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 2078. thus a mechanism name as defined by RFC 2743.
6.3. public interface GSSCredential implements Cloneable 6.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
GSS-API Java Bindings December 1999
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.
skipping to change at page 48, line 39 skipping to change at page 47, line 5
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. Example Code 6.3.1. 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.
GSSManager mgr = new GSSManager(); 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);
// now acquire credentials for the entity // now acquire credentials for the entity
GSSCredential cred = mgr.createCredential(name, GSSCredential cred = mgr.createCredential(name,
GSSCredential.ACCEPT_ONLY); GSSCredential.ACCEPT_ONLY);
// display credential information - name, remaining lifetime, // display credential information - name, remaining lifetime,
// and the mechanisms it has been acquired over // and the mechanisms it has been acquired over
print(cred.getName().toString()); print(cred.getName().toString());
print(cred.getRemainingLifetime()); print(cred.getRemainingLifetime());
GSS-API Java Bindings December 1999
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();
6.3.2. Static Constants 6.3.2. Static Constants
skipping to change at page 49, line 33 skipping to change at page 47, line 45
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. context initiation only.
public static final int ACCEPT_ONLY public static final int ACCEPT_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 acceptance only. context acceptance only.
public static final int INDEFINITE public static final int DEFAULT_LIFETIME
A lifetime constant representing the default credential lifetime.
This value must be set to 0.
public static final int INDEFINITE_LIFETIME
A lifetime constant representing indefinite credential lifetime. A lifetime constant representing indefinite credential lifetime.
This value must be set to the maximum integer value in Java - This value must be set to the maximum integer value in Java -
Integer.MAX_VALUE. Integer.MAX_VALUE.
6.3.3. dispose 6.3.3. 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.
GSS-API Java Bindings December 1999
6.3.4. getName 6.3.4. 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.5. getName 6.3.5. 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 7.3.3. Equivalent to calling canonicalize() on the name returned by 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.6. getRemainingLifetime 6.3.6. 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 GSSCredential.INDEFINITE credential mechanisms. A return value of
indicates that the credential does not expire. A return value of 0 GSSCredential.INDEFINITE_LIFETIME indicates that the credential does
indicates that the credential is already expired. not expire. A return value of 0 indicates that the credential is
already expired.
6.3.7. getRemainingInitLifetime 6.3.7. getRemainingInitLifetime
public int getRemainingInitLifetime(Oid mech) throws GSSException public int getRemainingInitLifetime(Oid mech) throws GSSException
Returns the remaining lifetime is seconds for the credential to Returns the remaining lifetime is 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 indicates that mechanism. A return value of GSSCredential.INDEFINITE_LIFETIME
the credential does not expire for context initiation. A return indicates that the credential does not expire for context initiation.
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.
GSS-API Java Bindings December 1999
6.3.8. getRemainingAcceptLifetime 6.3.8. getRemainingAcceptLifetime
public int getRemainingAcceptLifetime(Oid mech) throws GSSException public int getRemainingAcceptLifetime(Oid mech) throws GSSException
Returns the remaining lifetime is seconds for the credential to Returns the remaining lifetime is 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 indicates that mechanism. A return value of GSSCredential.INDEFINITE_LIFETIME
the credential does not expire for context acceptance. A return indicates that the credential does not expire for context acceptance.
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.9. getUsage 6.3.9. getUsage
public int getUsage() throws GSSException public int getUsage() throws GSSException
Returns the credential usage flag. The return value will be one of Returns the credential usage flag. The return value will be one of
GSSCredential.INITIATE_ONLY, GSSCredential.ACCEPT_ONLY, or GSSCredential.INITIATE_ONLY, GSSCredential.ACCEPT_ONLY, or
GSSCredential.INITIATE_AND_ACCEPT. GSSCredential.INITIATE_AND_ACCEPT.
6.3.10. getUsage 6.3.10. getUsage
public int getUsage(Oid mechOID) throws GSSException public int getUsage(Oid mechOID) throws GSSException
Returns the credential usage flag for the specified credential Returns the credential usage flag for the specified credential
mechanism. The return value will be one of mechanism. The return value will be one of
GSSCredential.INITIATE_ONLY, GSSCredential.ACCEPT_ONLY, or GSSCredential.INITIATE_ONLY, GSSCredential.ACCEPT_ONLY, or
GSSCredential.INITIATE_AND_ACCEPT. GSSCredential.INITIATE_AND_ACCEPT.
Parameters: Parameters:
mechOID The mechanism for which information should be mechOID The mechanism for which information should be
returned. returned.
6.3.11. getMechs 6.3.11. 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.
GSS-API Java Bindings December 1999
6.3.12. add 6.3.12. 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
with a variety of clients using different security mechanisms. with a variety of clients using different security mechanisms.
This routine adds the new credential element "in-place". To add the This routine adds the new credential element "in-place". To add the
element in a new credential, first call clone() to obtain a copy of element in a new credential, first call clone() to obtain a copy of
this credential, then call its add() method. this credential, then call its add() method.
Parameters: Parameters:
aName Name of the principal for whom this credential is to aName Name of the principal for whom this credential is to
be acquired. Use "null" to specify the default be acquired. Use "null" to specify the default
principal. principal.
initLifetime initLifetime
The number of seconds that credentials should remain The number of seconds that credentials should remain
valid for initiating of security contexts. Use valid for initiating of security contexts. Use
GSSCredential.INDEFINITE to request that the GSSCredential.INDEFINITE_LIFETIME to request that the
credentials have the maximum permitted lifetime. credentials have the maximum permitted lifetime. Use
GSSCredential.DEFAULT_LIFETIME to request default
credential lifetime.
acceptLifetime acceptLifetime
The number of seconds that credentials should remain The number of seconds that credentials should remain
valid for accepting of security contexts. Use valid for accepting of security contexts. Use
GSSCredential.INDEFINITE to request that the GSSCredential.INDEFINITE_LIFETIME to request that the
credentials have the maximum permitted lifetime. credentials have the maximum permitted lifetime. Use
GSSCredential.DEFAULT_LIFETIME to request default
credential lifetime.
mechOid 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. The usage The intended usage for this credential object. The
value of this parameter must be one of: value of this parameter must be one of:
GSSCredential.ACCEPT_AND_INITIATE, GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
6.3.13. equals 6.3.13. equals
public boolean equals(Object another) public boolean equals(Object another)
GSS-API Java Bindings December 1999
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 requires that two objects (Note that the Java language specification requires that two objects
that are equal according to the equals(Object) method must return the that are equal according to the equals(Object) method must return the
same integer result when the hashCode() method is called on them.) same integer result when the hashCode() method is called on them.)
Parameters: Parameters:
another Another GSSCredential object for comparison. another Another GSSCredential object for comparison.
6.4. public interface GSSContext 6.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
skipping to change at page 54, line 4 skipping to change at page 52, line 20
thrown and the code will start executing in a catch block. If not, thrown and the code will start executing in a catch block. If not,
the normal flow of code continues and the application can make a call the normal flow of code continues and the application can make a call
to the isEstablished() method. If this method returns false it to the isEstablished() method. If this method returns false it
indicates that a token is needed from its peer in order to continue indicates that a token is needed from its peer in order to continue
the context establishment phase. A return value of true signals that the context establishment phase. A return value of true signals that
the local end of the context is established. This may still require the local end of the context is established. This may still require
that a token be sent to the peer, if one is produced by GSS-API. that a token be sent to the peer, if one is produced by GSS-API.
During the context establishment phase, the isProtReady() method may During the context establishment phase, the isProtReady() method may
be called to determine if the context can be used for the per-message be called to determine if the context can be used for the per-message
operations. This allows applications to use per-message operations operations. This allows applications to use per-message operations
GSS-API Java Bindings December 1999
on contexts which aren't fully established. on contexts which 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
skipping to change at page 54, line 28 skipping to change at page 52, line 41
6.4.1. Example Code 6.4.1. 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.
GSSManager mgr = new GSSManager(); GSSManager mgr = GSSManager.getInstance();
// start by creating the name for a service entity // start by creating the name for a service entity
GSSName targetName = mgr.createName("service@host", GSSName targetName = mgr.createName("service@host",
GSSName.NT_HOSTBASED_SERVICE); GSSName.NT_HOSTBASED_SERVICE);
// create a context using default credentials for the above entity // create a context using default credentials for the above entity
// and the implementation specific default mechanism // and the implementation specific default mechanism
GSSContext context = mgr.createContext(targetName, GSSContext context = mgr.createContext(targetName,
null, /* default mechanism */ null, /* default mechanism */
null, /* default credentials */ null, /* default credentials */
GSSContext.INDEFINITE); GSSContext.INDEFINITE_LIFETIME);
// set desired context options - all others are false by default // set desired context options - all others are false by default
context.requestConf(true); context.requestConf(true);
context.requestMutualAuth(true); context.requestMutualAuth(true);
context.requestReplayDet(true); context.requestReplayDet(true);
context.requestSequenceDet(true); context.requestSequenceDet(true);
// establish a context between peers - using byte arrays // establish a context between peers - using byte arrays
byte []inTok = new byte[0]; byte []inTok = new byte[0];
try { try {
do { do {
byte[] outTok = context.initSecContext(inTok, 0, byte[] outTok = context.initSecContext(inTok, 0,
GSS-API Java Bindings December 1999
inTok.length); inTok.length);
// send the token if present // send the token if present
if (outTok != null) if (outTok != null)
sendToken(outTok); sendToken(outTok);
// check if we should expect more tokens // check if we should expect more tokens
if (context.isEstablished()) if (context.isEstablished())
break; break;
skipping to change at page 56, line 5 skipping to change at page 54, line 17
byte []tok = context.wrap(appMsg, 0, appMsg.length, mProp); byte []tok = context.wrap(appMsg, 0, appMsg.length, mProp);
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();
GSS-API Java Bindings December 1999
6.4.2. Static Constants 6.4.2. Static Constants
public static final int INDEFINITE public static final int DEFAULT_LIFETIME
A lifetime constant representing the default context lifetime. This
value must be set to 0.
public static final int INDEFINITE_LIFETIME
A lifetime constant representing indefinite context lifetime. This A lifetime constant representing indefinite context lifetime. This
value must be set to the maximum integer value in Java - value must be set to the maximum integer value in Java -
Integer.MAX_VALUE. Integer.MAX_VALUE.
6.4.3. initSecContext 6.4.3. 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 is equivalent to the stream based method except that process. This is equivalent to the stream based method except that
the token buffers are handled as byte arrays instead of using stream the token buffers are handled as byte arrays instead of using stream
objects. This method may return an output token which the objects. This method may return an output token which the
application will need to send to the peer for processing by the application will need to send to the peer for processing by the
accept call. "null" return value indicates that no token needs to be accept call. Typically, the application would do so by calling the
sent to the peer. The application can call isEstablished() to flush() method on an OutputStream that encapsulates the connection
between the two peers. The application can call isEstablished() to
determine if the context establishment phase is complete for this determine if the context establishment phase is complete for this
peer. A return value of "false" from isEstablished() indicates that peer. A return value of "false" from isEstablished() indicates that
more tokens are expected to be supplied to the initSecContext() more tokens are expected to be supplied to the initSecContext()
method. Note that it is possible that the initSecContext() method method. Note that it is possible that the initSecContext() method
return a token for the peer, and isEstablished() return "true" also. return a token for the peer, and isEstablished() return "true" also.
This indicates that the token needs to be sent to the peer, but the This indicates that the token needs to be sent to the peer, but the
local end of the context is now fully established. local 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.
Parameters: Parameters:
inputBuf Token generated by the peer. This parameter is ignored inputBuf Token generated by the peer. This parameter is ignored
on the first call. on the first call.
offset The offset within the inputBuf where the token begins. offset The offset within the inputBuf where the token begins.
len The length of the token within the inputBuf (starting len The length of the token within the inputBuf (starting
at the offset). at the offset).
6.4.3.1. Example Code 6.4.3.1. Example Code
// Create a new GSSContext implementation object. // Create a new GSSContext implementation object.
// GSSContext wrapper implements interface GSSContext. // GSSContext wrapper implements interface GSSContext.
GSS-API Java Bindings December 1999
GSSContext context = mgr.createContext(...); GSSContext context = mgr.createContext(...);
byte []inTok = new byte[0]; byte []inTok = new byte[0];
try { try {
do { do {
byte[] outTok = context.initSecContext(inTok, 0, byte[] outTok = context.initSecContext(inTok, 0,
inTok.length); inTok.length);
skipping to change at page 57, line 42 skipping to change at page 56, line 14
6.4.4. initSecContext 6.4.4. initSecContext
public int initSecContext(InputStream inStream, public int initSecContext(InputStream inStream,
OutputStream outStream) throws GSSException OutputStream outStream) throws GSSException
Called by the context initiator to start the context creation Called by the context initiator to start the context creation
process. This is equivalent to the byte array based method. This process. This is equivalent to the byte array based method. This
method may write an output token to the outStream, which the method may write an output token to the outStream, which the
application will need to send to the peer for processing by the application will need to send to the peer for processing by the
accept call. 0 bytes written to the output stream indicate that no accept call. Typically, the application would do so by calling the
token needs to be sent to the peer. The application can call flush() method on an OutputStream that encapsulates the connection
isEstablished() to determine if the context establishment phase is between the two peers. The application can call isEstablished() to
complete for this peer. A return value of "false" from isEstablished determine if the context establishment phase is complete for this
indicates that more tokens are expected to be supplied to the peer. A return value of "false" from isEstablished indicates that
initSecContext method. Note that it is possible that the more tokens are expected to be supplied to the initSecContext method.
initSecContext() method return a token for the peer, and Note that it is possible that the initSecContext() method return a
isEstablished() return "true" also. This indicates that the token token for the peer, and isEstablished() return "true" also. This
needs to be sent to the peer, but the local end of the context is now indicates that the token needs to be sent to the peer, but the local
end of the context is now fully established.
GSS-API Java Bindings December 1999
fully established.
The GSS-API authentication tokens contain a definitive start and end. The GSS-API authentication tokens contain a definitive start and end.
This method will attempt to read one of these tokens per invocation, This method will attempt to read one of these tokens per invocation,
and may block on the stream if only part of the token is available. and may block on the stream if only part of the token is available.
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.
Parameters: Parameters:
inStream Contains the token generated by the peer. This inStream Contains the token generated by the peer. This
parameter is ignored on the first call. parameter is ignored on the first call.
outStream Output stream where the output token will be written. outStream Output stream where the output token will be written.
During the final stage of context establishment, there During the final stage of context establishment, there
may be no bytes written. may be no bytes written.
6.4.4.1. Example Code 6.4.4.1. Example Code
This sample code merely demonstrates the token exchange during the
context establishment phase. It is expected that most Java
applications will use custom implementations of the Input and Output
streams that encapsulate the communication routines. For instance, a
simple read on the application InputStream, when called by the
Context, might cause a token to be read from the peer, and a simple
flush() on the application OutputStream might cause a previously
written token to be transmitted to the peer.
// Create a new GSSContext implementation object. // Create a new GSSContext implementation object.
// GSSContext wrapper implements interface GSSContext. // GSSContext wrapper implements interface GSSContext.
GSSContext context = mgr.createContext(...); GSSContext context = mgr.createContext(...);
// use standard java.io stream objects // use standard java.io stream objects
ByteArrayOutputStream os = new ByteArrayOutputStream(); ByteArrayOutputStream os = new ByteArrayOutputStream();
ByteArrayInputStream is = null; ByteArrayInputStream is = null;
try { try {
do { do {
skipping to change at page 59, line 5 skipping to change at page 57, line 30
// check if we should expect more tokens // check if we should expect more tokens
if (context.isEstablished()) if (context.isEstablished())
break; break;
// another token expected from peer // another token expected from peer
is = recvToken(); is = recvToken();
} while (true); } while (true);
GSS-API Java Bindings December 1999
} catch (GSSException e) { } catch (GSSException e) {
print("GSSAPI error: " + e.getMessage()); print("GSSAPI error: " + e.getMessage());
} }
6.4.5. acceptSecContext 6.4.5. 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.
skipping to change at page 59, line 39 skipping to change at page 58, line 15
Note that it is possible that acceptSecContext() return a token for Note that it is possible that acceptSecContext() return a token for
the peer, and isEstablished() return "true" also. This indicates the peer, and isEstablished() 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.
Parameters: Parameters:
inTok Token generated by the peer. inTok Token generated by the peer.
offset The offset within the inTok where the token begins. offset The offset within the inTok where the token begins.
len The length of the token within the inTok (starting at len The length of the token within the inTok (starting at
the offset). the offset).
6.4.5.1. Example Code 6.4.5.1. Example Code
// acquire server credentials // acquire server credentials
GSSCredential server = mgr.createCredential(...); GSSCredential server = mgr.createCredential(...);
GSS-API Java Bindings December 1999 // create acceptor GSS-API context from the default provider
// create acceptor GSS-API context fromthe default provider
GSSContext context = mgr.createContext(server, null); GSSContext context = mgr.createContext(server, null);
try { try {
do { do {
byte [] inTok = readToken(); byte [] inTok = readToken();
byte []outTok = context.acceptSecContext(inTok, 0, byte []outTok = context.acceptSecContext(inTok, 0,
inTok.length); inTok.length);
// possibly send token to peer // possibly send token to peer
skipping to change at page 60, line 38 skipping to change at page 59, line 13
} }
6.4.6. acceptSecContext 6.4.6. acceptSecContext
public void acceptSecContext(InputStream inStream, public void acceptSecContext(InputStream inStream,
OutputStream outStream) throws GSSException OutputStream outStream) 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 call is equivalent to the byte array method. It may write an This call is equivalent to the byte array method. It may write an
output token to the outStream, which the application will need to output token to the outStream, which the application will need to
send to the peer for processing by its initSecContext method. 0 bytes send to the peer for processing by its initSecContext method.
written to the output stream indicate that no token needs to be sent Typically, the application would do so by calling the flush() method
to the peer. The application can call isEstablished() to determine on an OutputStream that encapsulates the connection between the two
if the context establishment phase is complete for this peer. A peers. The application can call isEstablished() to determine if the
return value of "false" from isEstablished() indicates that more context establishment phase is complete for this peer. A return
tokens are expected to be supplied to this method. value of "false" from isEstablished() indicates that more tokens are
expected to be supplied to this method.
Note that it is possible that acceptSecContext() return a token for Note that it is possible that acceptSecContext() return a token for
the peer, and isEstablished() return "true" also. This indicates the peer, and isEstablished() 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.
The GSS-API authentication tokens contain a definitive start and end. The GSS-API authentication tokens contain a definitive start and end.
This method will attempt to read one of these tokens per invocation, This method will attempt to read one of these tokens per invocation,
and may block on the stream if only part of the token is available. and may block on the stream if only part of the token is available.
GSS-API Java Bindings December 1999
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.
Parameters: Parameters:
inStream Contains the token generated by the peer. inStream Contains the token generated by the peer.
outStream Output stream where the output token will be written. outStream Output stream where the output token will be written.
During the final stage of context establishment, there During the final stage of context establishment, there
may be no bytes written. may be no bytes written.
6.4.6.1. Example Code 6.4.6.1. Example Code
This sample code merely demonstrates the token exchange during the
context establishment phase. It is expected that most Java
applications will use custom implementations of the Input and Output
streams that encapsulate the communication routines. For instance, a
simple read on the application InputStream, when called by the
Context, might cause a token to be read from the peer, and a simple
flush() on the application OutputStream might cause a previously
written token to be transmitted to the peer.
// acquire server credentials // acquire server credentials
GSSCredential server = mgr.createCredential(...); GSSCredential server = mgr.createCredential(...);
// create acceptor GSS-API context fromthe default provider // create acceptor GSS-API context from the default provider
GSSContext context = mgr.createContext(server, null); GSSContext context = mgr.createContext(server, null);
// use standard java.io stream objects // use standard java.io stream objects
ByteArrayOutputStream os = new ByteArrayOutputStream(); ByteArrayOutputStream os = new ByteArrayOutputStream();
ByteArrayInputStream is = null; ByteArrayInputStream is = null;
try { try {
do { do {
is = recvToken(); is = recvToken();
skipping to change at page 62, line 5 skipping to change at page 60, line 33
// check if local context establishment is complete // check if local context establishment is complete
if (context.isEstablished()) if (context.isEstablished())
break; break;
} while (true); } while (true);
} catch (GSSException e) { } catch (GSSException e) {
print("GSS-API error: " + e.getMessage()); print("GSS-API error: " + e.getMessage());
} }
GSS-API Java Bindings December 1999
6.4.7. isEstablished 6.4.7. 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.
skipping to change at page 62, line 52 skipping to change at page 61, line 33
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 asked qop Indicates the level of protection wrap will be asked
to provide.
GSS-API Java Bindings December 1999
to provide.
confReq Indicates if wrap will be asked to provide privacy confReq Indicates if wrap will be asked to provide privacy
service. service.
maxTokenSize maxTokenSize
The desired maximum size of the token emitted by wrap. The desired maximum size of the token emitted by wrap.
6.4.10. wrap 6.4.10. 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. This method is may optionally encrypt the specified inBuf. This method is
equivalent in functionality to its stream counterpart. The returned equivalent in functionality to its stream counterpart. The returned
skipping to change at page 63, line 44 skipping to change at page 62, line 23
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 begins.
len The length of the data within the inBuf (starting at
the offset).
msgProp Instance of MessageProp that is used by the offset The offset within the inBuf where the data begins.
application to set the desired QOP and privacy state.
Set the desired QOP to 0 to request the default QOP.
GSS-API Java Bindings December 1999 len The length of the data within the inBuf (starting at
the offset).
Upon return from this method, this object will contain msgProp Instance of MessageProp that is used by the
the the actual privacy state that was applied to the application to set the desired QOP and privacy state.
message by the underlying mechanism. Set the desired QOP to 0 to request the default QOP.
Upon return from this method, this object will contain
the the actual privacy state that was applied to the
message by the underlying mechanism.
6.4.11. wrap 6.4.11. wrap
public void wrap(InputStream inStream, OutputStream outStream, public void wrap(InputStream inStream, OutputStream outStream,
MessageProp msgProp) throws GSSException MessageProp msgProp) throws GSSException
Allows to apply per-message security services over the established Allows to apply per-message security services over the established
security context. The method will produce a token with a security context. The method will produce a token with a
cryptographic MIC and may optionally encrypt the message in inStream. cryptographic MIC and may optionally encrypt the message in inStream.
The outStream will contain both the MIC and the message. The outStream will contain both the MIC and the message.
skipping to change at page 64, line 39 skipping to change at page 63, line 17
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:
inStream Input stream containing the application data to be inStream Input stream containing the application data to be
protected. protected.
outStream The output stream to write the protected message to.
The application is responsible for sending this to the
other peer for processing in its unwrap method.
msgProp Instance of MessageProp that is used by the outStream The output stream to write the protected message to.
application to set the desired QOP and privacy state. The application is responsible for sending this to the
Set the desired QOP to 0 to request the default QOP. other peer for processing in its unwrap method.
Upon return from this method, this object will contain
the the actual privacy state that was applied to the
message by the underlying mechanism.
GSS-API Java Bindings December 1999 msgProp Instance of MessageProp that is used by the
application to set the desired QOP and privacy state.
Set the desired QOP to 0 to request the default QOP.
Upon return from this method, this object will contain
the the actual privacy state that was applied to the
message by the underlying mechanism.
6.4.12. unwrap 6.4.12. 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. This call is equal in functionality to its stream wrap call. This call is equal in functionality to its stream
counterpart. The method will return the message supplied in the peer counterpart. 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.
skipping to change at page 65, line 28 skipping to change at page 64, line 7
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 begins. offset The offset within the inBuf where the token begins.
len The length of the token within the inBuf (starting at len The length of the token within the inBuf (starting at
the offset). the offset).
msgProp Upon return from the method, this object will contain msgProp Upon return from the method, this object will contain
the applied QOP, the privacy state of the message, and the applied QOP, the privacy state of the message, and
supplementary information described in 4.12.3 stating supplementary information described in 4.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. sequence or arriving after a gap.
6.4.13. unwrap 6.4.13. unwrap
public void unwrap(InputStream inStream, OutputStream outStream, public void unwrap(InputStream inStream, OutputStream outStream,
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. This call is equal in functionality to its byte array wrap call. This call is equal in functionality to its byte array
counterpart. It will produce the message supplied in the peer counterpart. It will produce 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
GSS-API Java Bindings December 1999
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:
inStream Input stream containing the GSS-API wrap token inStream Input stream containing the GSS-API wrap token
received from the peer. received from the peer.
outStream The output stream to write the application message to. outStream The output stream to write the application message to.
msgProp Upon return from the method, this object will contain msgProp Upon return from the method, this object will contain
the applied QOP, the privacy state of the message, and the applied QOP, the privacy state of the message, and
supplementary information described in 4.12.3 stating supplementary information described in 4.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. sequence or arriving after a gap.
6.4.14. getMIC 6.4.14. 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. This method is identical in MIC is returned in the output token. This method is identical in
functionality to its stream counterpart. functionality to its stream counterpart.
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 to generate MIC over. inMsg Message to generate MIC over.
offset The offset within the inMsg where the token begins.
len The length of the token within the inMsg (starting at
the offset).
msgProp Instance of MessageProp that is used by the offset The offset within the inMsg where the token begins.
application to set the desired QOP. Set the desired
GSS-API Java Bindings December 1999 len The length of the token within the inMsg (starting at
the offset).
QOP to 0 in msgProp to request the default QOP. msgProp Instance of MessageProp that is used by the
Alternatively pass in "null" for msgProp to request application to set the desired QOP. Set the desired
default QOP. QOP to 0 in msgProp to request the default QOP.
Alternatively pass in "null" for msgProp to request
default QOP.
6.4.15. getMIC 6.4.15. getMIC
public void getMIC(InputStream inStream, OutputStream outStream, public void getMIC(InputStream inStream, OutputStream outStream,
MessageProp msgProp) throws GSSException MessageProp msgProp) throws GSSException
Produces a token containing a cryptographic MIC for the supplied Produces 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 produced in the output token. This method is identical in MIC is produced in the output token. This method is identical in
functionality to its byte array counterpart. functionality to its byte array counterpart.
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:
inStream inStream Input stream containing the message to inStream inStream Input stream containing the message to
generate MIC over. generate MIC over.
outStream outStream Output stream to write the GSS-API output outStream outStream Output stream to write the GSS-API output
token to. token to.
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 desired application to set the desired QOP. Set the desired
QOP to 0 in msgProp to request the default QOP. QOP to 0 in msgProp to request the default QOP.
Alternatively pass in "null" for msgProp to request Alternatively pass in "null" for msgProp to request
default QOP. default QOP.
6.4.16. verifyMIC 6.4.16. 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. This method is equivalent in over the supplied message. This method is equivalent in
functionality to its stream counterpart. functionality to its stream counterpart.
The MessageProp object is instantiated by the application and is used The MessageProp object is instantiated by the application and is used
GSS-API Java Bindings December 1999
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 begins. tokOffset The offset within the inTok where the token begins.
tokLen The length of the token within the inTok (starting at tokLen The length of the token within the inTok (starting at
the offset). the offset).
inMsg Application message to verify the cryptographic MIC inMsg Application message to verify the cryptographic MIC
over. over.
msgOffset The offset within the inMsg where the message begins. msgOffset The offset within the inMsg where the message begins.
msgLen The length of the message within the inMsg (starting msgLen The length of the message within the inMsg (starting
at the offset). at the offset).
msgProp Upon return from the method, this object will contain msgProp Upon return from the method, this object will contain
the applied QOP and supplementary information the applied QOP and supplementary information
described in 4.12.3 stating whether the token was a described in 4.12.3 stating whether the token was a
duplicate, old, out of sequence or arriving after a duplicate, old, out of sequence or arriving after a
gap. The confidentiality state will be set to gap. The confidentiality state will be set to
"false". "false".
6.4.17. verifyMIC 6.4.17. verifyMIC
public void verifyMIC(InputStream tokStream, InputStream msgStream, public void verifyMIC(InputStream tokStream, InputStream msgStream,
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. This method is equivalent in over the supplied message. This method is equivalent in
functionality to its byte array counterpart. functionality to its byte array counterpart.
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
GSS-API Java Bindings December 1999
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:
tokStream Input stream containing the token generated by peer's tokStream Input stream containing the token generated by peer's
getMIC method. getMIC method.
msgStream Input stream containing the application message to msgStream Input stream containing the application message to
verify the cryptographic MIC over. verify the cryptographic MIC over.
msgProp Upon return from the method, this object will contain msgProp Upon return from the method, this object will contain
the applied QOP and supplementary information the applied QOP and supplementary information
described in 4.12.3 stating whether the token was a described in 4.12.3 stating whether the token was a
duplicate, old, out of sequence or arriving after a duplicate, old, out of sequence or arriving after a
gap. The confidentiality state will be set to gap. The confidentiality state will be set to
"false". "false".
6.4.18. export 6.4.18. 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
skipping to change at page 70, line 4 skipping to change at page 68, line 34
interprocess token may be imported, either as a function of local interprocess 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 interprocess token may contain security-sensitive information The interprocess token may contain security-sensitive information
(for example cryptographic keys). While mechanisms are encouraged to (for example cryptographic keys). While mechanisms are encouraged to
either avoid placing such sensitive information within interprocess either avoid placing such sensitive information within interprocess
tokens, or to encrypt the token before returning it to the tokens, or to encrypt the token before returning it to the
GSS-API Java Bindings December 1999
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 possible. Thus the application must take care to protect the
interprocess token, and ensure that any process to which the token is interprocess token, and ensure that any process to which the token is
transferred is trustworthy. transferred is trustworthy.
6.4.19. requestMutualAuth 6.4.19. 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 should state Boolean representing if mutual authentication should
be requested during context establishment. be requested during context establishment.
6.4.20. requestReplayDet 6.4.20. 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 desired state Boolean representing if replay detection is desired
over the established context. over the established context.
6.4.21. requestSequenceDet 6.4.21. 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 desired state Boolean representing if sequence detection is desired
over the established context. over the established context.
GSS-API Java Bindings December 1999
6.4.22. requestCredDeleg 6.4.22. 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.23. requestAnonymity 6.4.23. 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.24. requestConf 6.4.24. 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 are to state Boolean indicating if confidentiality services are to
be requested for the context. be requested for the context.
6.4.25. requestInteg 6.4.25. 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
GSS-API Java Bindings December 1999
only for the initiator. only for the initiator.
Parameters: Parameters:
state Boolean indicating if integrity services are to be state Boolean indicating if integrity services are to be
requested for the context. requested for the context.
6.4.26. requestLifetime 6.4.26. 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. the initiator. Use GSSContext.INDEFINITE_LIFETIME and
GSSContext.DEFAULT_LIFETIME to request indefinite or default context
lifetime.
Parameters: Parameters:
lifetime The desired context lifetime in seconds. lifetime The desired context lifetime in seconds.
6.4.27. setChannelBinding 6.4.27. 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.28. getCredDelegState 6.4.28. 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.29. getMutualAuthState 6.4.29. getMutualAuthState
public boolean getMutualAuthState() public boolean getMutualAuthState()
GSS-API Java Bindings December 1999
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.30. getReplayDetState 6.4.30. getReplayDetState
public boolean getReplayDetState() public boolean getReplayDetState()
skipping to change at page 74, line 5 skipping to change at page 72, line 24
indicate the actual state over the established context. indicate the actual state over the established context.
6.4.33. isTransferable 6.4.33. 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.
GSS-API Java Bindings December 1999
6.4.34. isProtReady 6.4.34. 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.
skipping to change at page 75, line 5 skipping to change at page 73, line 22
the remaining lifetime for the context. the remaining lifetime for the context.
6.4.38. getSrcName 6.4.38. 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.
GSS-API Java Bindings December 1999
6.4.39. getTargName 6.4.39. 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.40. getMech 6.4.40. getMech
public Oid getMech() throws GSSException public Oid getMech() throws GSSException
Returns the mechanism oid for this context. Returns the mechanism oid for this context. This method may be called
before the context is fully established, but the mechanism returned
may change on successive calls in negotiated mechanism case.
6.4.41. getDelegCred 6.4.41. 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.
skipping to change at page 76, line 4 skipping to change at page 74, line 18
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. should be used for QOP.
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
GSS-API Java Bindings December 1999
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 6.5.1. Constructors
public MessageProp(boolean privState) public MessageProp(boolean privState)
Constructor which sets QOP to 0 indicating that the default QOP is Constructor which 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.
public MessageProp(int qop, boolean privState) public MessageProp(int qop, boolean privState)
Constructor which sets the values for the qop and privacy state. Constructor which 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 6.5.2. getQOP
public int getQOP() public int getQOP()
Retrieves the QOP value. Retrieves the QOP value.
6.5.3. getPrivacy 6.5.3. getPrivacy
public boolean getPrivacy() public boolean getPrivacy()
Retrieves the privacy state. Retrieves the privacy state.
GSS-API Java Bindings December 1999
6.5.4. getMinorStatus 6.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 6.5.5. getMinorString
public String getMinorString() public String getMinorString()
skipping to change at page 77, line 29 skipping to change at page 75, line 39
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 6.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 default qopVal The QOP value to be set. Use 0 to request a default
QOP value. QOP value.
6.5.7. setPrivacy 6.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 6.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.
GSS-API Java Bindings December 1999
6.5.9. isOldToken 6.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 6.5.10. isUnseqToken
public boolean isUnseqToken() public boolean isUnseqToken()
skipping to change at page 78, line 38 skipping to change at page 76, line 42
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.
Parameters: Parameters:
duplicate true if the token was a duplicate of an earlier token, duplicate true if the token was a duplicate of an earlier token,
false otherwise false otherwise
old true if the token's validity period has expired, false
otherwise
unseq true if a later token has already been processed, old true if the token's validity period has expired, false
false otherwise otherwise
gap true if one or more predecessor tokens have not yet unseq true if a later token has already been processed,
been successfully processed, false otherwise false otherwise
minorStatus the integer minor status code that the underlying gap true if one or more predecessor tokens have not yet
mechanism wants to set been successfully processed, false otherwise
GSS-API Java Bindings December 1999 minorStatus the integer minor status code that the underlying
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 6.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.
skipping to change at page 79, line 40 skipping to change at page 77, line 41
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 which the and data. "null" values can be used for any fields which the
application does not want to specify. application does not want to specify.
Parameters: Parameters:
initAddr The address of the context initiator. "null" value initAddr The address of the context initiator. "null" value
can be supplied to indicate that the application does can be supplied to indicate that the application does
not want to set this value. not want to set this value.
acceptAddrThe address of the context acceptor. "null" value can
be supplied to indicate that the application does not
want to set this value.
appData Application supplied data to be used as part of the
channel bindings. "null" value can be supplied to
indicate that the application does not want to set
GSS-API Java Bindings December 1999 acceptAddrThe address of the context acceptor. "null" value can
be supplied to indicate that the application does not
want to set this value.
this value. appData Application supplied data to be used as part of the
channel bindings. "null" value can be supplied to
indicate that the application does not want to set
this value.
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 the appData Application supplied data to be used as part of the
channel bindings. channel bindings.
6.6.2. getInitiatorAddress 6.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 6.6.3. getAcceptorAddress
skipping to change at page 81, line 5 skipping to change at page 78, line 45
6.6.5. equals 6.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.)
GSS-API Java Bindings December 1999
Parameters: Parameters:
obj Another channel binding to compare with. obj Another channel binding to compare with.
6.7. public class Oid 6.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
skipping to change at page 81, line 35 skipping to change at page 79, line 29
6.7.1. Constructors 6.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.
public Oid(InputStream derOid) throws GSSException public Oid(InputStream derOid) throws GSSException
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 Stream containing the DER encoded oid. derOid Stream containing the DER encoded oid.
public Oid(byte[] DEROid) throws GSSException public Oid(byte[] DEROid) throws GSSException
GSS-API Java Bindings December 1999
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 6.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 6.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 requires that two objects (Note that the Java language specification requires that two objects
that are equal according to the equals(Object) method must return the that are equal according to the equals(Object) method must return the
same integer result when the hashCode() method is called on them.) same integer result when the hashCode() method is called on them.)
Parameters: Parameters:
obj Another Oid object to compare with. obj Another Oid object to compare with.
6.7.4. getDER 6.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 6.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:
GSS-API Java Bindings December 1999 oids An array of oids to search.
oids An array of oids to search.
6.8. public class GSSException extends Exception 6.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 implementers are and minor, GSS-API status codes. The mechanism implementers 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. All Java GSS-API methods are declared to textual representations. All Java GSS-API methods are declared
skipping to change at page 84, line 5 skipping to change at page 81, line 32
public static final int BAD_NAME public static final int BAD_NAME
Invalid name provided error. Invalid name provided error.
public static final int BAD_NAMETYPE public static final int BAD_NAMETYPE
Name of unsupported type provided error. Name of unsupported type provided error.
public static final int BAD_STATUS public static final int BAD_STATUS
GSS-API Java Bindings December 1999
Invalid status code error - this is the default status value. Invalid status code error - this is the default status value.
public static final int BAD_MIC public static final int BAD_MIC
Token had invalid integrity check error. Token had invalid integrity check error.
public static final int CONTEXT_EXPIRED public static final int CONTEXT_EXPIRED
Specified security context expired error. Specified security context expired error.
skipping to change at page 85, line 5 skipping to change at page 82, line 29
Invalid security context error. Invalid security context error.
public static final int NO_CRED public static final int NO_CRED
Invalid credentials error. Invalid credentials error.
public static final int BAD_QOP public static final int BAD_QOP
Unsupported QOP value error. Unsupported QOP value error.
GSS-API Java Bindings December 1999
public static final int UNAUTHORIZED public static final int UNAUTHORIZED
Operation unauthorized error. Operation unauthorized error.
public static final int UNAVAILABLE public static final int UNAVAILABLE
Operation unavailable error. Operation unavailable error.
public static final int DUPLICATE_ELEMENT public static final int DUPLICATE_ELEMENT
skipping to change at page 86, line 4 skipping to change at page 83, line 30
A later token has already been processed. This is a fatal error code A later token has already been processed. This is a fatal error code
that may occur during context establishment. It is not used to that may occur during context establishment. It is not used to
indicate supplementary status values. The MessageProp object is used indicate supplementary status values. The MessageProp object is used
for that purpose. for that purpose.
public static final int GAP_TOKEN public static final int GAP_TOKEN
An expected per-message token was not received. This is a fatal An expected per-message token was not received. This is a fatal
error code that may occur during context establishment. It is not error code that may occur during context establishment. It is not
GSS-API Java Bindings December 1999
used to indicate supplementary status values. The MessageProp object used to indicate supplementary status values. The MessageProp object
is used for that purpose. is used for that purpose.
6.8.2. Constructors 6.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.
Parameters: Parameters:
majorCode The GSS error code causing this exception to be majorCode The GSS error code causing this exception to be
thrown. thrown.
public GSSException(int majorCode, int minorCode, String minorString) public GSSException(int majorCode, int minorCode, String minorString)
Creates a GSSException object with the specified major code, minor Creates a GSSException object with the specified major code, minor
code, and minor code textual explanation. This constructor is to be code, and minor code textual explanation. This constructor is to be
used when the exception is originating from the security mechanism. used when the exception is originating from the security mechanism.
It allows to specify the GSS code and the mechanism code. It allows to specify the GSS code and the mechanism code.
Parameters: Parameters:
majorCode The GSS error code causing this exception to be majorCode The GSS error code causing this exception to be
thrown. thrown.
minorCode The mechanism error code causing this exception minorCode The mechanism error code causing this exception
to be thrown. to be thrown.
minorString The textual explanation of the mechanism error minorString The textual explanation of the mechanism error
code. code.
6.8.3. getMajor 6.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 6.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
GSS-API Java Bindings December 1999
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 6.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.
skipping to change at page 87, line 33 skipping to change at page 85, line 7
6.8.7. setMinor 6.8.7. 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 code. message A textual explanation of the mechanism error code.
6.8.8. toString 6.8.8. 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.9. getMessage 6.8.9. 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
GSS-API Java Bindings December 1999
obtain exception information. obtain exception information.
7. Sample Applications 7. Sample Applications
Full Copyright Statement
Copyright (C) The Internet Society (1999). All Rights Reserved.
This document and translations of it may be copied and furnished
to others, and derivative works that comment on or otherwise explain
it or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than
English.
The limited permissions granted above are perpetual and will not
be revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on
an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
7.1. Simple GSS Context Initiator 7.1. Simple GSS Context Initiator
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
* draft-ietf-cat-gssv2-javabind-04.txt. * Generic Security Service API Version 2 : Java bindings
*
* *
* This code sketch assumes the existence of a GSS-API * This code sketch assumes the existence of a GSS-API
GSS-API Java Bindings December 1999
* implementation that supports the mechanism that it will need and * implementation that supports the mechanism that it will need and
* is present as a library package (org.ietf.jgss) either as part of * is present as a library package (org.ietf.jgss) either as part of
* the standard JRE or in the CLASSPATH the application specifies. * the standard JRE or in the CLASSPATH the application specifies.
*/ */
public class SimpleClient { public class SimpleClient {
private String serviceName; // name of peer (ie. server) private String serviceName; // name of peer (ie. server)
private GSSCredential clientCred = null; private GSSCredential clientCred = null;
private GSSContext context = null; private GSSContext context = null;
skipping to change at page 89, line 39 skipping to change at page 86, line 21
} }
/** /**
* Acquire credentials for the client. * Acquire credentials for the client.
*/ */
private void initializeGSS() { private void initializeGSS() {
try { try {
clientCred = mgr.createCredential(null /*default princ*/, clientCred = mgr.createCredential(null /*default princ*/,
GSSCredential.INDEFINITE /* max lifetime */, GSSCredential.INDEFINITE_LIFETIME /* max lifetime */,
mech /* mechanism to use */, mech /* mechanism to use */,
GSSCredential.INITIATE_ONLY /* init context */); GSSCredential.INITIATE_ONLY /* init context */);
print("GSSCredential created for " + print("GSSCredential created for " +
cred.getName().toString()); cred.getName().toString());
print("Credential lifetime (sec)=" + print("Credential lifetime (sec)=" +
cred.getRemainingLifetime()); cred.getRemainingLifetime());
} catch (GSSException e) { } catch (GSSException e) {
print("GSS-API error in credential acquisition: " print("GSS-API error in credential acquisition: "
+ e.getMessage()); + e.getMessage());
... ...
... ...
} }
... ...
GSS-API Java Bindings December 1999
... ...
} }
/** /**
* Does the security context establishment with the * Does the security context establishment with the
* server. * server.
*/ */
private void establishContext() { private void establishContext() {
byte[] inToken = new byte[0]; byte[] inToken = new byte[0];
byte[] outToken = null; byte[] outToken = null;
try { try {
GSSName peer = mgr.createName(serviceName, GSSName peer = mgr.createName(serviceName,
GSSName.NT_HOSTBASED_SERVICE); GSSName.NT_HOSTBASED_SERVICE);
context = mgr.createContext(peer, mech, gssCred, context = mgr.createContext(peer, mech, gssCred,
GSSContext.INDEFINITE/*lifetime*/); GSSContext.INDEFINITE_LIFETIME/*lifetime*/);
// Will need to support confidentiality // Will need to support confidentiality
context.requestConf(true); context.requestConf(true);
while (!context.isEstablished()) { while (!context.isEstablished()) {
outToken = context.initSecContext(inToken, 0, outToken = context.initSecContext(inToken, 0,
inToken.length); inToken.length);
if (outToken != null) if (outToken != null)
skipping to change at page 91, line 5 skipping to change at page 87, line 38
print("GSS-API error during context establishment: " print("GSS-API error during context establishment: "
+ e.getMessage()); + e.getMessage());
... ...
... ...
} }
... ...
... ...
} }
GSS-API Java Bindings December 1999
/** /**
* Sends some data to the server and reads back the * Sends some data to the server and reads back the
* response. * response.
*/ */
private void doCommunication() { private void doCommunication() {
byte[] inToken = null; byte[] inToken = null;
byte[] outToken = null; byte[] outToken = null;
byte[] buffer; byte[] buffer;
// Container for multiple input-output arguments to and // Container for multiple input-output arguments to and
skipping to change at page 92, line 4 skipping to change at page 88, line 37
// All ok if no exception was thrown! // All ok if no exception was thrown!
GSSName peer = context.getSrcName(); GSSName peer = context.getSrcName();
print("Message from " + peer.toString() print("Message from " + peer.toString()
+ " arrived."); + " arrived.");
print("Was it encrypted? " + print("Was it encrypted? " +
messgInfo.getPrivacy()); messgInfo.getPrivacy());
print("Duplicate Token? " + print("Duplicate Token? " +
messgInfo.isDuplicateToken()); messgInfo.isDuplicateToken());
GSS-API Java Bindings December 1999
print("Old Token? " + print("Old Token? " +
messgInfo.isOldToken()); messgInfo.isOldToken());
print("Unsequenced Token? " + print("Unsequenced Token? " +
messgInfo.isUnseqToken()); messgInfo.isUnseqToken());
print("Gap Token? " + print("Gap Token? " +
messgInfo.isGapToken()); messgInfo.isGapToken());
... ...
... ...
skipping to change at page 92, line 42 skipping to change at page 89, line 26
} // end of class SimpleClient } // end of class SimpleClient
7.2. Simple GSS Context Acceptor 7.2. Simple GSS Context Acceptor
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
* draft-ietf-cat-gssv2-javabind-04.txt. * Generic Security Service API Version 2 : Java bindings
* *
* This code sketch assumes the existence of a GSS-API * This code sketch assumes the existence of a GSS-API
* implementation that supports the mechanisms that it will need and * implementation that supports the mechanisms that it will need and
* is present as a library package (org.ietf.jgss) either as part of * is present as a library package (org.ietf.jgss) either as part of
* the standard JRE or in the CLASSPATH the application specifies. * the standard JRE or in the CLASSPATH the application specifies.
*/ */
GSS-API Java Bindings December 1999
import org.ietf.jgss.*; import org.ietf.jgss.*;
public class SimpleServer { public class SimpleServer {
private String serviceName; private String serviceName;
private GSSName name; private GSSName name;
private GSSCredential cred; private GSSCredential cred;
private GSSManager mgr; private GSSManager mgr;
skipping to change at page 93, line 25 skipping to change at page 90, line 4
private GSSManager mgr; private GSSManager mgr;
... ...
... ...
/** /**
* Wait for client connections, establish security contexts and * Wait for client connections, establish security contexts and
* provide service. * provide service.
*/ */
private void loop() { private void loop() {
... ...
... ...
mgr = GSSManager.getInstance(); mgr = GSSManager.getInstance();
name = mgr.createName(serviceName, name = mgr.createName(serviceName,
GSSName.NT_HOSTBASED_SERVICE); GSSName.NT_HOSTBASED_SERVICE);
cred = mgr.createCredential(name, cred = mgr.createCredential(name,
GSSCredential.INDEFINITE, GSSCredential.INDEFINITE_LIFETIME,
null, null,
GSSCredential.ACCEPT_ONLY); GSSCredential.ACCEPT_ONLY);
// Loop infinitely // Loop infinitely
while (true) { while (true) {
Socket s = serverSock.acceptSecContext(); Socket s = serverSock.accept();
// Start a new thread to serve this connection // Start a new thread to serve this connection
Thread serverThread = new ServerThread(s); Thread serverThread = new ServerThread(s);
serverThread.start(); serverThread.start();
} }
} }
/** /**
* Inner class ServerThread whose run() method provides the * Inner class ServerThread whose run() method provides the
* secure service to a connection. * secure service to a connection.
GSS-API Java Bindings December 1999
*/ */
private class ServerThread extends Thread { private class ServerThread extends Thread {
... ...
... ...
/** /**
* Deals with the connection from one client. It also * Deals with the connection from one client. It also
* handles all GSSException's thrown while talking to * handles all GSSException's thrown while talking to
skipping to change at page 95, line 4 skipping to change at page 91, line 30
outToken = context.acceptSecContext(inToken, 0, outToken = context.acceptSecContext(inToken, 0,
inToken.length); inToken.length);
if (outToken != null) if (outToken != null)
writeGSSToken(outToken); writeGSSToken(outToken);
} }
// SimpleServer wants confidentiality to be // SimpleServer wants confidentiality to be
// available. Check for it. // available. Check for it.
GSS-API Java Bindings December 1999
if (!context.getConfState()){ if (!context.getConfState()){
... ...
... ...
} }
GSSName peer = context.getSrcName(); GSSName peer = context.getSrcName();
Oid mech = context.getMech(); Oid mech = context.getMech();
print("Security context established with " + print("Security context established with " +
peer.toString() + peer.toString() +
" using underlying mechanism " + " using underlying mechanism " +
skipping to change at page 96, line 4 skipping to change at page 92, line 32
/* /*
* Now process the bytes and send back an encrypted * Now process the bytes and send back an encrypted
* response. * response.
*/ */
buffer = serverProcess(buffer); buffer = serverProcess(buffer);
// Encipher it and send it across // Encipher it and send it across
supplInfo.setPrivacy(true); // privacy requested supplInfo.setPrivacy(true); // privacy requested
GSS-API Java Bindings December 1999
supplInfo.setQOP(0); // default QOP supplInfo.setQOP(0); // default QOP
outToken = context.wrap(buffer, 0, buffer.length, outToken = context.wrap(buffer, 0, buffer.length,
supplInfo); supplInfo);
writeGSSToken(outToken); writeGSSToken(outToken);
} catch (GSSException e) { } catch (GSSException e) {
print("GSS-API Error: " + e.getMessage()); print("GSS-API Error: " + e.getMessage());
// Alternatively, could call e.getMajorMessage() // Alternatively, could call e.getMajorMessage()
// and e.getMinorMessage() // and e.getMinorMessage()
print("Abandoning security context."); print("Abandoning security context.");
skipping to change at page 96, line 40 skipping to change at page 93, line 17
... ...
... ...
} // end of class SimpleServer } // end of class SimpleServer
8. Security Considerations 8. 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 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
GSS provider might have for system resources. For instance, a GSS provider might have for system resources. For instance, a
Kerberos provider might wish to make a network connection to the KDC Kerberos provider might wish to make a network connection to the KDC
to obtain initial credentials. This would not be allowed under the to obtain initial credentials. This would not be allowed under the
sandbox unless the administrator had granted permissions for this. sandbox unless the administrator had granted permissions for this.
Also note that this granting and checking of permissions happens Also note that this granting and checking of permissions happens
transparently to the application and is outside the scope of this transparently to the application and is outside the scope of this
document.
GSS-API Java Bindings December 1999 The Java language allows administrators to pre-configure a list of
draft.
The Java language allows admininstrators to pre-configure a list of
security service providers in the <JRE>/lib/security/java.security security service providers in the <JRE>/lib/security/java.security
file. At runtime, the system approaches these providers in order of file. At runtime, the system approaches these providers in order of
preference when looking for security related services. Applications preference when looking for security related services. Applications
have a means to modify this list through methods in the "Security" have a means to modify this list through methods in the "Security"
class in the "java.security" package. However, since these class in the "java.security" package. However, since these
modifications would be visible in the entire JVM and thus affect all modifications would be visible in the entire JVM and thus affect all
code executing in it, this operation is not available in the sandbox code executing in it, this operation is not available in the sandbox
and requires special permissions to perform. Thus when a GSS and requires special permissions to perform. Thus when a GSS
application has special needs that are met by a particular security application has special needs that are met by a particular security
provider, it has two choices: provider, it has two choices:
1) To install the provider on a JVM wide basis using the 1) To install the provider on a JVM wide basis using the
java.security.Security class and then depend on the system java.security.Security class and then depend on the system to
to find the right provider automatically when the need find the right provider automatically when the need arises.
arises. (This would require the application to be granted a (This would require the application to be granted a
"insertProvider SecurityPermission".) "insertProvider SecurityPermission".)
2) To pass an instance of the provider to the local instance 2) To pass an instance of the provider to the local instance of
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 GSSManager use the desired provider. (This would not require
require any permissions.) any permissions.)
9. Acknowledgments 9. 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 2078 and J. Wray's C-bindings draft for WG as outlined in both RFC 2743 and RFC 2744. Many conceptual
the GSS-API. Many conceptual definitions, implementation directions, definitions, implementation directions, and explanations have been
and explanations have been included from the C-bindings draft. 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 draft. insightful ideas and suggestions that have contributed to this
document.
GSS-API Java Bindings December 1999
10. Bibliography 10. Bibliography
[GSSAPIv2] [GSSAPIv2] Linn, J., "Generic Security Service Application
J. Linn, "Generic Security Service Application Program Interface, Program Interface, Version 2", RFC 2078, January
Version 2", RFC 2078, January 1997. 1997.
[GSSAPIv2-UPDATE]
J. Linn, "Generic Security Service Application Program Interface,
Version 2, Update 1", IETF work in progress, Internet Draft, July
1998.
[GSSAPI-Cbind] [GSSAPIv2-UPDATE] Linn, J., "Generic Security Service Application
J. Wray, "Generic Security Service API Version 2 : C-bindings", IETF Program Interface, Version 2, Update 1", RFC 2743,
work in progress, Internet Draft, July 1998. January 2000.
[KERBEROS_V5] [GSSAPI-Cbind] Wray, J., "Generic Security Service API Version 2 :
J. Linn, "The Kerberos Version 5 GSS-API Mechanism", RFC 1964, June C-bindings", RFC 2744, January 2000.
1996.
[SPKM] [KERBV5] Linn, J., "The Kerberos Version 5 GSS-API
C. Adams, "The Simple Public-Key GSS-API Mechanism", RFC 2025, Mechanism", RFC 1964, June 1996.
October 1996.
GSS-API Java Bindings December 1999 [SPKM] Adams, C., "The Simple Public-Key GSS-API
Mechanism", RFC 2025, October 1996.
11. Author's Address 11. Authors' Addresses
Address comments related to this memorandum to: Address comments related to this memorandum to:
<cat-ietf@mit.edu> <cat-ietf@mit.edu>
Jack Kabat Jack Kabat
ValiCert, Inc. ValiCert, Inc.
1215 Terra Bella Avenue 339 N. Bernardo Avenue
Mountain View, CA Mountain View, CA
94043, USA 94043, USA
Phone: +1-650-567-5496 Phone: +1-650-567-5496
E-mail: jackk@valicert.com EMail: jackk@valicert.com
Mayank Upadhyay Mayank Upadhyay
Sun Microsystems, Inc. Sun Microsystems, Inc.
901 San Antonio Road, MS CUP02-102 901 San Antonio Road, MS CUP02-102
Palo Alto, CA 94303 Palo Alto, CA 94303
Phone: +1-408-517-5956 Phone: +1-408-517-5956
E-mail: mdu@eng.sun.com EMail: mdu@eng.sun.com
12. Full Copyright Statement
Copyright (C) The Internet Society (2000). All Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than
English.
The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Acknowledgement
Funding for the RFC Editor function is currently provided by the
Internet Society.
 End of changes. 348 change blocks. 
1099 lines changed or deleted 848 lines changed or added

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