draft-ietf-cat-gssv2-javabind-02.txt   draft-ietf-cat-gssv2-javabind-03.txt 
Internet-Draft Jack Kabat Internet-Draft Jack Kabat
IETF CAT Working Group ValiCert, Inc. IETF CAT Working Group ValiCert, Inc.
Document: <draft-ietf-cat-gssv2-javabind-02.txt> Mayank Upadhyay Document: <draft-ietf-cat-gssv2-javabind-03.txt> Mayank Upadhyay
Sun Microsystems, Inc. Sun Microsystems, Inc.
October 1999
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 is an Internet-Draft and is in full conformance with
all provisions of Section 10 of RFC2026. all provisions of Section 10 of RFC2026.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet- other groups may also distribute working documents as Internet-
skipping to change at page 2, line 5 skipping to change at page 2, line 5
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 2078 [GSSAPIv2].
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 October 1999
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 6 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 6
2. GSS-API Operational Paradigm . . . . . . . . . . . . . . . . 7 2. GSS-API Operational Paradigm . . . . . . . . . . . . . . . . 7
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 . . . . . . . . . . 11
3.4. Anonymous Authentication . . . . . . . . . . . . . . . . 11 3.4. Anonymous Authentication . . . . . . . . . . . . . . . . 11
3.5. Confidentiality . . . . . . . . . . . . . . . . . . . . 12 3.5. Confidentiality . . . . . . . . . . . . . . . . . . . . 12
skipping to change at page 2, line 37 skipping to change at page 2, line 39
4.10. Authentication tokens . . . . . . . . . . . . . . . . . 19 4.10. Authentication tokens . . . . . . . . . . . . . . . . . 19
4.11. Interprocess tokens . . . . . . . . . . . . . . . . . . 19 4.11. Interprocess tokens . . . . . . . . . . . . . . . . . . 19
4.12. Error Reporting . . . . . . . . . . . . . . . . . . . . 20 4.12. Error Reporting . . . . . . . . . . . . . . . . . . . . 20
4.12.1. GSS status codes . . . . . . . . . . . . . . . . . . 20 4.12.1. GSS status codes . . . . . . . . . . . . . . . . . . 20
4.12.2. Mechanism-specific status codes . . . . . . . . . . . 22 4.12.2. Mechanism-specific status codes . . . . . . . . . . . 22
4.12.3. Supplementary status codes . . . . . . . . . . . . . 22 4.12.3. Supplementary status codes . . . . . . . . . . . . . 22
4.13. Names . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.13. Names . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.14. Channel Bindings . . . . . . . . . . . . . . . . . . . 26 4.14. Channel Bindings . . . . . . . . . . . . . . . . . . . 26
4.15. Stream Objects . . . . . . . . . . . . . . . . . . . . 27 4.15. Stream Objects . . . . . . . . . . . . . . . . . . . . 27
4.16. Optional Parameters . . . . . . . . . . . . . . . . . . 27 4.16. Optional Parameters . . . . . . . . . . . . . . . . . . 27
5. GSS Provider's Interface . . . . . . . . . . . . . . . . . 27 5. Introduction to GSS-API Classes and Interfaces . . . . . . 27
5.1. GSSFactory interface . . . . . . . . . . . . . . . . . . 28 5.1. GSSManager class . . . . . . . . . . . . . . . . . . . . 28
5.2. IGSSName interface . . . . . . . . . . . . . . . . . . . 28 5.2. GSSName interface . . . . . . . . . . . . . . . . . . . 28
5.3. IGSSCredential interface . . . . . . . . . . . . . . . . 29 5.3. GSSCredential interface . . . . . . . . . . . . . . . . 29
5.4. IGSSContext interface . . . . . . . . . . . . . . . . . 30 5.4. GSSContext interface . . . . . . . . . . . . . . . . . . 30
6. GSS Application Programmer's Classes . . . . . . . . . . . 31 5.5. MessageProp class . . . . . . . . . . . . . . . . . . . 31
6.1. GSSManager class . . . . . . . . . . . . . . . . . . . . 32 5.6. GSSException class . . . . . . . . . . . . . . . . . . . 31
6.2. GSSName class . . . . . . . . . . . . . . . . . . . . . 32 5.7. Oid class . . . . . . . . . . . . . . . . . . . . . . . 32
6.3. GSSCredential class . . . . . . . . . . . . . . . . . . 32 5.8. ChannelBinding class . . . . . . . . . . . . . . . . . . 32
6.4. GSSContext class . . . . . . . . . . . . . . . . . . . . 32 6. Detailed GSS-API Class Description . . . . . . . . . . . . 32
6.5. MessageProp class . . . . . . . . . . . . . . . . . . . 33 6.1. public class GSSManager . . . . . . . . . . . . . . . . 32
6.6. GSSException class . . . . . . . . . . . . . . . . . . . 33 6.1.1. Example Code . . . . . . . . . . . . . . . . . . . . . 33
6.7. Oid class . . . . . . . . . . . . . . . . . . . . . . . 33 6.1.2. Constructors . . . . . . . . . . . . . . . . . . . . . 33
6.8. ChannelBinding class . . . . . . . . . . . . . . . . . . 33 6.1.3. setProvider . . . . . . . . . . . . . . . . . . . . . 34
7. Detailed GSS-API Class Description . . . . . . . . . . . . 34 6.1.4. setProvider . . . . . . . . . . . . . . . . . . . . . 34
7.1. public interface GSSFactory . . . . . . . . . . . . . . 34 6.1.5. getProvider . . . . . . . . . . . . . . . . . . . . . 35
7.1.1. createName . . . . . . . . . . . . . . . . . . . . . . 34
7.1.2. createName . . . . . . . . . . . . . . . . . . . . . . 35 GSS-API Java Bindings October 1999
7.1.3. createName . . . . . . . . . . . . . . . . . . . . . . 36
7.1.4. createName . . . . . . . . . . . . . . . . . . . . . . 36 6.1.6. getMechs . . . . . . . . . . . . . . . . . . . . . . . 35
7.1.5. createCredential . . . . . . . . . . . . . . . . . . . 37 6.1.7. getNamesForMech . . . . . . . . . . . . . . . . . . . 35
7.1.6. createCredential . . . . . . . . . . . . . . . . . . . 37 6.1.8. getMechsForName . . . . . . . . . . . . . . . . . . . 36
7.1.7. createCredential . . . . . . . . . . . . . . . . . . . 38 6.1.9. createName . . . . . . . . . . . . . . . . . . . . . . 36
7.1.8. createContext . . . . . . . . . . . . . . . . . . . . 38 6.1.10. createName . . . . . . . . . . . . . . . . . . . . . 36
7.1.9. createContext . . . . . . . . . . . . . . . . . . . . 39 6.1.11. createName . . . . . . . . . . . . . . . . . . . . . 37
7.1.10. createContext . . . . . . . . . . . . . . . . . . . . 39 6.1.12. createName . . . . . . . . . . . . . . . . . . . . . 38
7.1.11. getMechs . . . . . . . . . . . . . . . . . . . . . . 39 6.1.13. createCredential . . . . . . . . . . . . . . . . . . 38
7.1.12. getMechsForName . . . . . . . . . . . . . . . . . . . 40 6.1.14. createCredential . . . . . . . . . . . . . . . . . . 38
7.1.13. getNamesForMech . . . . . . . . . . . . . . . . . . . 40 6.1.15. createCredential . . . . . . . . . . . . . . . . . . 39
7.2. public interface IGSSName extends java.security.Principal 40 6.1.16. createContext . . . . . . . . . . . . . . . . . . . . 40
7.2.1. Static Constants . . . . . . . . . . . . . . . . . . . 41 6.1.17. createContext . . . . . . . . . . . . . . . . . . . . 40
7.2.2. equals . . . . . . . . . . . . . . . . . . . . . . . . 42 6.1.18. createContext . . . . . . . . . . . . . . . . . . . . 41
7.2.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 42 6.2. public interface GSSName . . . . . . . . . . . . . . . . 41
7.2.4. canonicalize . . . . . . . . . . . . . . . . . . . . . 42 6.2.1. Example Code . . . . . . . . . . . . . . . . . . . . . 41
7.2.5. export . . . . . . . . . . . . . . . . . . . . . . . . 43 6.2.2. Static Constants . . . . . . . . . . . . . . . . . . . 42
7.2.6. toString . . . . . . . . . . . . . . . . . . . . . . . 43 6.2.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 43
7.2.7. getStringNameType . . . . . . . . . . . . . . . . . . 43 6.2.4. equals . . . . . . . . . . . . . . . . . . . . . . . . 43
7.2.8. isAnonymous . . . . . . . . . . . . . . . . . . . . . 43 6.2.5. canonicalize . . . . . . . . . . . . . . . . . . . . . 44
7.2.9. isMN . . . . . . . . . . . . . . . . . . . . . . . . . 44 6.2.6. export . . . . . . . . . . . . . . . . . . . . . . . . 44
7.3. public interface IGSSCredential implements Cloneable . . 44 6.2.7. toString . . . . . . . . . . . . . . . . . . . . . . . 44
7.3.1. Static Constants . . . . . . . . . . . . . . . . . . . 45 6.2.8. getStringNameType . . . . . . . . . . . . . . . . . . 44
7.3.2. dispose . . . . . . . . . . . . . . . . . . . . . . . 45 6.2.9. isAnonymous . . . . . . . . . . . . . . . . . . . . . 45
7.3.3. getName . . . . . . . . . . . . . . . . . . . . . . . 45 6.2.10. isMN . . . . . . . . . . . . . . . . . . . . . . . . 45
7.3.4. getName . . . . . . . . . . . . . . . . . . . . . . . 46 6.3. public interface GSSCredential implements Cloneable . . 45
7.3.5. getRemainingLifetime . . . . . . . . . . . . . . . . . 46 6.3.1. Example Code . . . . . . . . . . . . . . . . . . . . . 46
7.3.6. getRemainingInitLifetime . . . . . . . . . . . . . . . 46 6.3.2. Static Constants . . . . . . . . . . . . . . . . . . . 47
7.3.7. getRemainingAcceptLifetime . . . . . . . . . . . . . . 46 6.3.3. dispose . . . . . . . . . . . . . . . . . . . . . . . 47
7.3.8. getUsage . . . . . . . . . . . . . . . . . . . . . . . 47 6.3.4. getName . . . . . . . . . . . . . . . . . . . . . . . 47
7.3.9. getUsage . . . . . . . . . . . . . . . . . . . . . . . 47 6.3.5. getName . . . . . . . . . . . . . . . . . . . . . . . 47
7.3.10. getMechs . . . . . . . . . . . . . . . . . . . . . . 47 6.3.6. getRemainingLifetime . . . . . . . . . . . . . . . . . 48
7.3.11. add . . . . . . . . . . . . . . . . . . . . . . . . . 47 6.3.7. getRemainingInitLifetime . . . . . . . . . . . . . . . 48
7.3.12. equals . . . . . . . . . . . . . . . . . . . . . . . 48 6.3.8. getRemainingAcceptLifetime . . . . . . . . . . . . . . 48
7.4. public interface IGSSContext . . . . . . . . . . . . . . 49 6.3.9. getUsage . . . . . . . . . . . . . . . . . . . . . . . 49
7.4.1. Static Constants . . . . . . . . . . . . . . . . . . . 50 6.3.10. getUsage . . . . . . . . . . . . . . . . . . . . . . 49
7.4.2. initSecContext . . . . . . . . . . . . . . . . . . . . 50 6.3.11. getMechs . . . . . . . . . . . . . . . . . . . . . . 49
7.4.2.1. Example Code . . . . . . . . . . . . . . . . . . . . 51 6.3.12. add . . . . . . . . . . . . . . . . . . . . . . . . . 49
7.4.3. initSecContext . . . . . . . . . . . . . . . . . . . . 51 6.3.13. equals . . . . . . . . . . . . . . . . . . . . . . . 50
7.4.3.1. Example Code . . . . . . . . . . . . . . . . . . . . 52 6.4. public interface GSSContext . . . . . . . . . . . . . . 51
7.4.4. acceptSecContext . . . . . . . . . . . . . . . . . . . 53 6.4.1. Example Code . . . . . . . . . . . . . . . . . . . . . 52
7.4.4.1. Example Code . . . . . . . . . . . . . . . . . . . . 54 6.4.2. Static Constants . . . . . . . . . . . . . . . . . . . 53
7.4.5. acceptSecContext . . . . . . . . . . . . . . . . . . . 54 6.4.3. initSecContext . . . . . . . . . . . . . . . . . . . . 54
7.4.5.1. Example Code . . . . . . . . . . . . . . . . . . . . 55 6.4.3.1. Example Code . . . . . . . . . . . . . . . . . . . . 54
7.4.6. isEstablished . . . . . . . . . . . . . . . . . . . . 56 6.4.4. initSecContext . . . . . . . . . . . . . . . . . . . . 55
7.4.7. dispose . . . . . . . . . . . . . . . . . . . . . . . 56 6.4.4.1. Example Code . . . . . . . . . . . . . . . . . . . . 56
7.4.8. getWrapSizeLimit . . . . . . . . . . . . . . . . . . . 56 6.4.5. acceptSecContext . . . . . . . . . . . . . . . . . . . 57
7.4.9. wrap . . . . . . . . . . . . . . . . . . . . . . . . . 57 6.4.5.1. Example Code . . . . . . . . . . . . . . . . . . . . 57
7.4.10. wrap . . . . . . . . . . . . . . . . . . . . . . . . 58 6.4.6. acceptSecContext . . . . . . . . . . . . . . . . . . . 58
7.4.11. unwrap . . . . . . . . . . . . . . . . . . . . . . . 59
7.4.12. unwrap . . . . . . . . . . . . . . . . . . . . . . . 59 GSS-API Java Bindings October 1999
7.4.13. getMIC . . . . . . . . . . . . . . . . . . . . . . . 60
7.4.14. getMIC . . . . . . . . . . . . . . . . . . . . . . . 61 6.4.6.1. Example Code . . . . . . . . . . . . . . . . . . . . 59
7.4.15. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 61 6.4.7. isEstablished . . . . . . . . . . . . . . . . . . . . 59
7.4.16. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 62 6.4.8. dispose . . . . . . . . . . . . . . . . . . . . . . . 60
7.4.17. export . . . . . . . . . . . . . . . . . . . . . . . 63 6.4.9. getWrapSizeLimit . . . . . . . . . . . . . . . . . . . 60
7.4.18. requestMutualAuth . . . . . . . . . . . . . . . . . . 64 6.4.10. wrap . . . . . . . . . . . . . . . . . . . . . . . . 61
7.4.19. requestReplayDet . . . . . . . . . . . . . . . . . . 64 6.4.11. wrap . . . . . . . . . . . . . . . . . . . . . . . . 61
7.4.20. requestSequenceDet . . . . . . . . . . . . . . . . . 64 6.4.12. unwrap . . . . . . . . . . . . . . . . . . . . . . . 62
7.4.21. requestCredDeleg . . . . . . . . . . . . . . . . . . 65 6.4.13. unwrap . . . . . . . . . . . . . . . . . . . . . . . 63
7.4.22. requestAnonymity . . . . . . . . . . . . . . . . . . 65 6.4.14. getMIC . . . . . . . . . . . . . . . . . . . . . . . 64
7.4.23. requestConf . . . . . . . . . . . . . . . . . . . . . 65 6.4.15. getMIC . . . . . . . . . . . . . . . . . . . . . . . 64
7.4.24. requestInteg . . . . . . . . . . . . . . . . . . . . 66 6.4.16. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 65
7.4.25. requestLifetime . . . . . . . . . . . . . . . . . . . 66 6.4.17. verifyMIC . . . . . . . . . . . . . . . . . . . . . . 66
7.4.26. setChannelBinding . . . . . . . . . . . . . . . . . . 66 6.4.18. export . . . . . . . . . . . . . . . . . . . . . . . 67
7.4.27. getCredDelegState . . . . . . . . . . . . . . . . . . 66 6.4.19. requestMutualAuth . . . . . . . . . . . . . . . . . . 67
7.4.28. getMutualAuthState . . . . . . . . . . . . . . . . . 67 6.4.20. requestReplayDet . . . . . . . . . . . . . . . . . . 68
7.4.29. getReplayDetState . . . . . . . . . . . . . . . . . . 67 6.4.21. requestSequenceDet . . . . . . . . . . . . . . . . . 68
7.4.30. getSequenceDetState . . . . . . . . . . . . . . . . . 67 6.4.22. requestCredDeleg . . . . . . . . . . . . . . . . . . 68
7.4.31. getAnonymityState . . . . . . . . . . . . . . . . . . 67 6.4.23. requestAnonymity . . . . . . . . . . . . . . . . . . 69
7.4.32. isTransferable . . . . . . . . . . . . . . . . . . . 67 6.4.24. requestConf . . . . . . . . . . . . . . . . . . . . . 69
7.4.33. isProtReady . . . . . . . . . . . . . . . . . . . . . 68 6.4.25. requestInteg . . . . . . . . . . . . . . . . . . . . 69
7.4.34. getConfState . . . . . . . . . . . . . . . . . . . . 68 6.4.26. requestLifetime . . . . . . . . . . . . . . . . . . . 69
7.4.35. getIntegState . . . . . . . . . . . . . . . . . . . . 68 6.4.27. setChannelBinding . . . . . . . . . . . . . . . . . . 70
7.4.36. getLifetime . . . . . . . . . . . . . . . . . . . . . 68 6.4.28. getCredDelegState . . . . . . . . . . . . . . . . . . 70
7.4.37. getSrcName . . . . . . . . . . . . . . . . . . . . . 68 6.4.29. getMutualAuthState . . . . . . . . . . . . . . . . . 70
7.4.38. getTargName . . . . . . . . . . . . . . . . . . . . . 69 6.4.30. getReplayDetState . . . . . . . . . . . . . . . . . . 70
7.4.39. getMech . . . . . . . . . . . . . . . . . . . . . . . 69 6.4.31. getSequenceDetState . . . . . . . . . . . . . . . . . 71
7.4.40. getDelegCred . . . . . . . . . . . . . . . . . . . . 69 6.4.32. getAnonymityState . . . . . . . . . . . . . . . . . . 71
7.4.41. isInitiator . . . . . . . . . . . . . . . . . . . . . 69 6.4.33. isTransferable . . . . . . . . . . . . . . . . . . . 71
7.5. public class MessageProp . . . . . . . . . . . . . . . . 69 6.4.34. isProtReady . . . . . . . . . . . . . . . . . . . . . 71
7.5.1. Constructors . . . . . . . . . . . . . . . . . . . . . 70 6.4.35. getConfState . . . . . . . . . . . . . . . . . . . . 71
7.5.2. getQOP . . . . . . . . . . . . . . . . . . . . . . . . 70 6.4.36. getIntegState . . . . . . . . . . . . . . . . . . . . 72
7.5.3. getPrivacy . . . . . . . . . . . . . . . . . . . . . . 70 6.4.37. getLifetime . . . . . . . . . . . . . . . . . . . . . 72
7.5.4. setQOP . . . . . . . . . . . . . . . . . . . . . . . . 71 6.4.38. getSrcName . . . . . . . . . . . . . . . . . . . . . 72
7.5.5. setPrivacy . . . . . . . . . . . . . . . . . . . . . . 71 6.4.39. getTargName . . . . . . . . . . . . . . . . . . . . . 72
7.5.6. isDuplicateToken . . . . . . . . . . . . . . . . . . . 71 6.4.40. getMech . . . . . . . . . . . . . . . . . . . . . . . 72
7.5.7. isOldToken . . . . . . . . . . . . . . . . . . . . . . 71 6.4.41. getDelegCred . . . . . . . . . . . . . . . . . . . . 73
7.5.8. isUnseqToken . . . . . . . . . . . . . . . . . . . . . 71 6.4.42. isInitiator . . . . . . . . . . . . . . . . . . . . . 73
7.5.9. isGapToken . . . . . . . . . . . . . . . . . . . . . . 72 6.5. public class MessageProp . . . . . . . . . . . . . . . . 73
7.5.10. setSupplementaryStates . . . . . . . . . . . . . . . 72 6.5.1. Constructors . . . . . . . . . . . . . . . . . . . . . 73
7.6. public class ChannelBinding . . . . . . . . . . . . . . 72 6.5.2. getQOP . . . . . . . . . . . . . . . . . . . . . . . . 74
7.6.1. Constructors . . . . . . . . . . . . . . . . . . . . . 73 6.5.3. getPrivacy . . . . . . . . . . . . . . . . . . . . . . 74
7.6.2. getInitiatorAddress . . . . . . . . . . . . . . . . . 73 6.5.4. getMinorStatus . . . . . . . . . . . . . . . . . . . . 74
7.6.3. getAcceptorAddress . . . . . . . . . . . . . . . . . . 74 6.5.5. getMinorString . . . . . . . . . . . . . . . . . . . . 74
7.6.4. getApplicationData . . . . . . . . . . . . . . . . . . 74 6.5.6. setQOP . . . . . . . . . . . . . . . . . . . . . . . . 75
7.6.5. equals . . . . . . . . . . . . . . . . . . . . . . . . 74 6.5.7. setPrivacy . . . . . . . . . . . . . . . . . . . . . . 75
7.7. public class Oid . . . . . . . . . . . . . . . . . . . . 74 6.5.8. isDuplicateToken . . . . . . . . . . . . . . . . . . . 75
7.7.1. Constructors . . . . . . . . . . . . . . . . . . . . . 75 6.5.9. isOldToken . . . . . . . . . . . . . . . . . . . . . . 75
7.7.2. toString . . . . . . . . . . . . . . . . . . . . . . . 75 6.5.10. isUnseqToken . . . . . . . . . . . . . . . . . . . . 75
7.7.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 75
7.7.4. getDER . . . . . . . . . . . . . . . . . . . . . . . . 76 GSS-API Java Bindings October 1999
7.7.5. containedIn . . . . . . . . . . . . . . . . . . . . . 76
7.8. public class GSSException extends Exception . . . . . . 76 6.5.11. isGapToken . . . . . . . . . . . . . . . . . . . . . 75
7.8.1. Static Constants . . . . . . . . . . . . . . . . . . . 76 6.5.12. setSupplementaryStates . . . . . . . . . . . . . . . 76
7.8.2. Constructors . . . . . . . . . . . . . . . . . . . . . 79 6.6. public class ChannelBinding . . . . . . . . . . . . . . 76
7.8.3. getMajor . . . . . . . . . . . . . . . . . . . . . . . 80 6.6.1. Constructors . . . . . . . . . . . . . . . . . . . . . 77
7.8.4. getMinor . . . . . . . . . . . . . . . . . . . . . . . 80 6.6.2. getInitiatorAddress . . . . . . . . . . . . . . . . . 77
7.8.5. getMajorString . . . . . . . . . . . . . . . . . . . . 80 6.6.3. getAcceptorAddress . . . . . . . . . . . . . . . . . . 78
7.8.6. getMinorString . . . . . . . . . . . . . . . . . . . . 80 6.6.4. getApplicationData . . . . . . . . . . . . . . . . . . 78
7.8.7. setMinor . . . . . . . . . . . . . . . . . . . . . . . 81 6.6.5. equals . . . . . . . . . . . . . . . . . . . . . . . . 78
7.8.8. toString . . . . . . . . . . . . . . . . . . . . . . . 81 6.7. public class Oid . . . . . . . . . . . . . . . . . . . . 78
7.8.9. getMessage . . . . . . . . . . . . . . . . . . . . . . 81 6.7.1. Constructors . . . . . . . . . . . . . . . . . . . . . 79
7.9. public abstract class GSSManager . . . . . . . . . . . . 81 6.7.2. toString . . . . . . . . . . . . . . . . . . . . . . . 79
7.9.1. Example . . . . . . . . . . . . . . . . . . . . . . . 82 6.7.3. equals . . . . . . . . . . . . . . . . . . . . . . . . 80
7.9.2. setDefaultProvider . . . . . . . . . . . . . . . . . . 82 6.7.4. getDER . . . . . . . . . . . . . . . . . . . . . . . . 80
7.9.3. getDefaultProvider . . . . . . . . . . . . . . . . . . 83 6.7.5. containedIn . . . . . . . . . . . . . . . . . . . . . 80
7.9.4. getMechs . . . . . . . . . . . . . . . . . . . . . . . 83 6.8. public class GSSException extends Exception . . . . . . 80
7.9.5. getNamesForMech . . . . . . . . . . . . . . . . . . . 83 6.8.1. Static Constants . . . . . . . . . . . . . . . . . . . 81
7.9.6. getMechsForName . . . . . . . . . . . . . . . . . . . 83 6.8.2. Constructors . . . . . . . . . . . . . . . . . . . . . 83
7.9.7. getProviderFromToken . . . . . . . . . . . . . . . . . 84 6.8.3. getMajor . . . . . . . . . . . . . . . . . . . . . . . 84
7.9.8. getProviderForMechanism . . . . . . . . . . . . . . . 84 6.8.4. getMinor . . . . . . . . . . . . . . . . . . . . . . . 84
7.10. public class GSSName implements IGSSName . . . . . . . 85 6.8.5. getMajorString . . . . . . . . . . . . . . . . . . . . 84
7.10.1. Example . . . . . . . . . . . . . . . . . . . . . . . 86 6.8.6. getMinorString . . . . . . . . . . . . . . . . . . . . 84
7.10.2. Constructors . . . . . . . . . . . . . . . . . . . . 87 6.8.7. setMinor . . . . . . . . . . . . . . . . . . . . . . . 85
7.10.3. getProvider . . . . . . . . . . . . . . . . . . . . . 89 6.8.8. toString . . . . . . . . . . . . . . . . . . . . . . . 85
7.11. public class GSSCredential implements IGSSCredential . 89 6.8.9. getMessage . . . . . . . . . . . . . . . . . . . . . . 85
7.11.1. Example . . . . . . . . . . . . . . . . . . . . . . . 90 7. Sample Applications . . . . . . . . . . . . . . . . . . . 85
7.11.2. Constructors . . . . . . . . . . . . . . . . . . . . 91 7.1. Simple GSS Context Initiator . . . . . . . . . . . . . . 86
7.11.3. getProvider . . . . . . . . . . . . . . . . . . . . . 93 7.2. Simple GSS Context Acceptor . . . . . . . . . . . . . . 90
7.12. public class GSSContext implements IGSSContext . . . . 93 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . 94
7.12.1. Example . . . . . . . . . . . . . . . . . . . . . . . 96 9. Bibliography . . . . . . . . . . . . . . . . . . . . . . . 95
7.12.2. Constructors . . . . . . . . . . . . . . . . . . . . 97 10. Author's Address . . . . . . . . . . . . . . . . . . . . 96
7.12.3. getProvider . . . . . . . . . . . . . . . . . . . . . 99
8. Sample Applications . . . . . . . . . . . . . . . . . . . 99 GSS-API Java Bindings October 1999
8.1. Simple GSS Context Initiator . . . . . . . . . . . . . . 100
8.2. GSS Context Acceptor Using Multiple Providers . . . . . 104
8.3. GSS Context Initiator Using the Provider Factory Directly 108
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . 112
10. Bibliography . . . . . . . . . . . . . . . . . . . . . . 114
11. Author's Address . . . . . . . . . . . . . . . . . . . . 115
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 (GSS-API) Version
2. GSS-API Version 2 is described in a language independent format in 2. GSS-API Version 2 is described in a language independent format in
RFC 2078 [GSSAPIv2]. The GSS-API allows a caller application to RFC 2078 [GSSAPIv2]. The GSS-API allows a caller application to
authenticate a principal identity, to delegate rights to a peer, and authenticate a principal identity, to delegate rights to a peer, and
to apply security services such as confidentiality and integrity on a to apply security services such as confidentiality and integrity on a
per-message basis. per-message basis.
skipping to change at page 6, line 39 skipping to change at page 6, line 41
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 allow applications to add to and The design of this API also aims to provide a flexible framework to
choose between GSS-API implementations at runtime. Key elements from add and manage GSS-API mechanisms. GSS-API leverages the JCA provider
one implementation may be added to the remaining framework from concept to support the plugability of mechanisms. Mechanisms can be
another implementation ("system-wide") to support new mechanisms with added on a "system-wide" basis, where all users of the framework will
minimum addition of binaries. This is particularly useful to applet have them available. The specification also allows for the addition
developers who need flexibility in choice but prefer to remain of mechanisms per-instance the GSS-API.
lightweight.
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 October 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. [GSSAPIv2] defines a generic security API to calling applications.
It allows a communicating application to authenticate the user It allows a communicating application to authenticate the user
associated with another application, to delegate rights to another associated with another application, to delegate rights to another
application, and to apply security services such as confidentiality application, and to apply security services such as confidentiality
and integrity on a per-message basis. and integrity on a per-message basis.
There are four stages to using GSS-API: There are four stages to using GSS-API:
skipping to change at page 7, line 42 skipping to change at page 7, line 44
initiator. The initiator may optionally give the responder initiator. The initiator may optionally give the responder
the right to initiate further security contexts, acting as the right to initiate further security contexts, acting as
an agent or delegate of the initiator. This transfer of an agent or delegate of the initiator. This transfer of
rights is termed "delegation", and is achieved by creating rights is termed "delegation", and is achieved by creating
a set of credentials, similar to those used by the a set of credentials, similar to those used by the
initiating application, but which may be used by the initiating application, but which may be used by the
responder. responder.
A GSSContext object is used to establish and maintain the A GSSContext object is used to establish and maintain the
shared information that makes up the security context. shared information that makes up the security context.
(Please note that for the purposes of this discussion,
GSSContext and IGSSContext are used interchangeably).
Certain GSSContext methods will generate a token, which Certain GSSContext methods will generate a token, which
applications treat as cryptographically protected, opaque applications treat as cryptographically protected, opaque
data. The caller of such GSSContext method is responsible data. The caller of such GSSContext method is responsible
for transferring the token to the peer application, for transferring the token to the peer application,
encapsulated if necessary in an application-to-application encapsulated if necessary in an application-to-application
protocol. On receipt of such a token, the peer application protocol. On receipt of such a token, the peer application
should pass it to a corresponding GSSContext method which should pass it to a corresponding GSSContext method which
will decode the token and extract the information, updating will decode the token and extract the information, updating
the security context state information accordingly. the security context state information accordingly.
GSS-API Java Bindings October 1999
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 octet-strings. An application transmitting a arbitrary octet-strings. An application transmitting a
message that it wishes to protect will call the appropriate message that it wishes to protect will call the appropriate
GSSContext method (getMIC or wrap) to apply protection, and GSSContext method (getMIC or wrap) to apply protection, and
send the resulting token to the receiving application. The send the resulting token to the receiving application. The
receiver will pass the received token (and, in the case of receiver will pass the received token (and, in the case of
data protected by getMIC, the accompanying message-data) to data protected by getMIC, the accompanying message-data) to
the corresponding decoding method of the GSSContext class the corresponding decoding method of the GSSContext
(verifyMIC or unwrap) to remove the protection and validate interface (verifyMIC or unwrap) to remove the protection
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 across several transport connections), each extend across several transport connections), each
application uses a GSSContext method to invalidate the application uses a GSSContext method to invalidate the
security context and release any system or cryptographic security context and release any system or cryptographic
resources held. Multiple contexts may also be used (either resources held. Multiple contexts may also be used (either
successively or simultaneously) within a single successively or simultaneously) within a single
communications association, at the discretion of the communications association, at the discretion of the
applications. applications.
skipping to change at page 9, line 7 skipping to change at page 9, line 4
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
GSS-API Java Bindings October 1999
context acceptor, the context acceptor should also authenticate context acceptor, the context acceptor should also authenticate
itself to the initiator. 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 message
numbering information to enable verifyMIC and unwrap to detect numbering information to enable verifyMIC and unwrap to detect
if a message has been duplicated. if a message has been duplicated.
Out-of-Sequence Detection Out-of-Sequence Detection
skipping to change at page 9, line 28 skipping to change at page 9, line 28
per-message operations (getMIC and wrap) should include message per-message operations (getMIC and wrap) should include message
sequencing information to enable verifyMIC and unwrap to detect sequencing information to enable verifyMIC and unwrap to detect
if a message has been received out of sequence. 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 class offers query methods to allow the verification The GSSContext interface offers query methods to allow the
by the calling application of which services will be available from verification by the calling application of which services will be
the context when the establishment phase is complete. In general, if available from the context when the establishment phase is complete.
the security mechanism is capable of providing a requested service, In general, if the security mechanism is capable of providing a
it should do so even if additional services must be enabled in order requested service, it should do so even if additional services must
to provide the requested service. If the mechanism is incapable of be enabled in order to provide the requested service. If the
providing a requested service, it should proceed without the service mechanism is incapable of providing a requested service, it should
leaving the application to abort the context establishment process if proceed without the service leaving the application to abort the
it considers the requested service to be mandatory. context establishment process if it considers the requested service
to be mandatory.
Some mechanisms may specify that support for some services is Some mechanisms may specify that support for some services is
optional, and that implementors of the mechanism need not provide it. optional, and that implementors of the mechanism need not provide it.
This is most commonly true of the confidentiality service, often This is most commonly true of the confidentiality service, often
because of legal restrictions on the use of data-encryption, but may because of legal restrictions on the use of data-encryption, but may
apply to any of the services. Such mechanisms are required to send apply to any of the services. Such mechanisms are required to send
at least one token from acceptor to initiator during context at least one token from acceptor to initiator during context
establishment when the initiator indicates a desire to use such a establishment when the initiator indicates a desire to use such a
service, so that the initiating GSS-API can correctly indicate service, so that the initiating GSS-API can correctly indicate
whether the service is supported by the acceptor's GSS-API. whether the service is supported by the acceptor's GSS-API.
3.1. Delegation 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 October 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 class. In cases when it getCredDelegState method of the GSSContext interface. In cases when
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 IGSSCredential 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. (Please note that for the purposes of delegate of the initiator. If the original initiator's identity is
this discussion GSSCredential and IGSSCredential are used "A" and the delegate's identity is "B", then, depending on the
interchangeably.) If the original initiator's identity is "A" and underlying mechanism, the identity embodied by the delegated
the delegate's identity is "B", then, depending on the underlying credential may be either "A" or "B acting for A".
mechanism, the identity embodied by the delegated credential may be
either "A" or "B acting for A".
For many mechanisms that support delegation, a simple boolean does For many mechanisms that support delegation, a simple boolean does
not provide enough control. Examples of additional aspects of not provide enough control. Examples of additional aspects of
delegation control that a mechanism might provide to an application delegation control that a mechanism might provide to an application
are duration of delegation, network addresses from which delegation are duration of delegation, network addresses from which delegation
is valid, and constraints on the tasks that may be performed by a is valid, and constraints on the tasks that may be performed by a
delegate. Such controls are presently outside the scope of the GSS- delegate. Such controls are presently outside the scope of the GSS-
API. GSS-API implementations supporting mechanisms offering API. GSS-API implementations supporting mechanisms offering
additional controls should provide extension routines that allow additional controls should provide extension routines that allow
these controls to be exercised (perhaps by modifying the initiator's these controls to be exercised (perhaps by modifying the initiator's
skipping to change at page 10, line 48 skipping to change at page 10, line 48
of the application. of the application.
3.2. Mutual Authentication 3.2. Mutual Authentication
Usually, a context acceptor will require that a context initiator Usually, a context acceptor will require that a context initiator
authenticate itself so that the acceptor may make an access-control authenticate itself so that the acceptor may make an access-control
decision prior to performing a service for the initiator. In some decision prior to performing a service for the initiator. In some
cases, the initiator may also request that the acceptor authenticate cases, the initiator may also request that the acceptor authenticate
itself. GSS-API allows the initiating application to request this itself. GSS-API allows the initiating application to request this
mutual authentication service by calling the requestMutualAuth method mutual authentication service by calling the requestMutualAuth method
of the GSSContext class 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 October 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
methods of the GSSContext class, and verified by the peer application methods of the GSSContext interface, and verified by the peer
by calling verifyMIC or unwrap for the peer's GSSContext object. application by calling verifyMIC or unwrap for the peer's GSSContext
object.
The getMIC method calculates a cryptographic checksum of an The getMIC method calculates a cryptographic checksum of an
application message, and returns that checksum in a token. The application message, and returns that checksum in a token. The
application should pass both the token and the message to the peer application should pass both the token and the message to the peer
application, which presents them to the verifyMIC method of the application, which presents them to the verifyMIC method of the
peer's GSSContext object. peer's GSSContext object.
The wrap method calculates a cryptographic checksum of an application The wrap method calculates a cryptographic checksum of an application
message, and places both the checksum and the message inside a single message, and places both the checksum and the message inside a single
token. The application should pass the token to the peer token. The application should pass the token to the peer
skipping to change at page 12, line 6 skipping to change at page 12, line 4
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 October 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 12, line 30 skipping to change at page 12, line 31
establishment if anonymity is valued above the other security establishment if anonymity is valued above the other security
services that would require a context to be established. services that would require a context to be established.
In addition to informing the application that a context is In addition to informing the application that a context is
established anonymously (via the isAnonymous method of the GSSContext established anonymously (via the isAnonymous method of the GSSContext
class), the getSrcName method of the acceptor's GSSContext object class), the getSrcName method of the acceptor's GSSContext object
will, for such contexts, return a reserved internal-form name, will, for such contexts, return a reserved internal-form name,
defined by the implementation. defined by the implementation.
The toString method for a GSSName object representing an anonymous The toString method for a GSSName object representing an anonymous
entity will return a printable name. (Please note that for the entity will return a printable name. The returned value will be
purposes of this discussion GSSName and IGSSName are used syntactically distinguishable from any valid principal name supported
interchangeably.) The returned value will be syntactically by the implementation. The associated name-type object identifier
distinguishable from any valid principal name supported by the will be an oid representing the value of NT_ANONYMOUS. This name-
implementation. The associated name-type object identifier will be type oid will be defined as a public, static Oid object of the
an oid representing the value of NT_ANONYMOUS. This name-type oid GSSName class. The printable form of an anonymous name should be
will be defined as a public, static Oid object of the GSSName class. chosen such that it implies anonymity, since this name may appear in,
The printable form of an anonymous name should be chosen such that it for example, audit logs. For example, the string "<anonymous>" might
implies anonymity, since this name may appear in, for example, audit be a good choice, if no valid printable names supported by the
logs. For example, the string "<anonymous>" might be a good choice, implementation can begin with "<" and end with ">".
if no valid printable names supported by the implementation can begin
with "<" and end with ">".
When using the equal method of the GSSName class, and one of the When using the equal method of the GSSName interface, and one of the
operands is a GSSName instance representing an anonymous entity, the operands is a GSSName instance representing an anonymous entity, the
method must return "false". method must return "false".
3.5. 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 October 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
context object created within the parent so that they can use per- context object created within the parent so that they can use per-
message protection services and delete the security context when the message protection services and delete the security context when the
communication session ends. communication session ends.
Since the security context data structure is expected to contain Since the security context data structure is expected to contain
sequencing information, it is impractical in general to share a sequencing information, it is impractical in general to share a
context between processes. Thus GSSContext class provides an export context between processes. Thus GSSContext interface provides an
method that the process, which currently owns the context, can call export method that the process, which currently owns the context, can
to declare that it has no intention to use the context subsequently, call to declare that it has no intention to use the context
and to create an inter-process token containing information needed by subsequently, and to create an inter-process token containing
the adopting process to successfully re-create the context. After information needed by the adopting process to successfully re-create
successful completion of export, the original security context is the context. After successful completion of export, the original
made inaccessible to the calling process by GSS-API and any further security context is made inaccessible to the calling process by GSS-
usage of this object will result in failures. The originating API and any further usage of this object will result in failures.
process transfers the inter-process token to the adopting process, The originating process transfers the inter-process token to the
which creates a new GSSContext object using the byte array adopting process, which creates a new GSSContext object using the
constructor. The properties of the context are equivalent to that of byte array constructor. The properties of the context are equivalent
the original context. to that of the original context.
The inter-process token may contain sensitive data from the original The inter-process token may contain sensitive data from the original
security context (including cryptographic keys). Applications using security context (including cryptographic keys). Applications using
inter-process tokens to transfer security contexts must take inter-process tokens to transfer security contexts must take
appropriate steps to protect these tokens in transit. appropriate steps to protect these tokens in transit.
Implementations are not required to support the inter-process Implementations are not required to support the inter-process
transfer of security contexts. Calling the isTransferable method of transfer of security contexts. Calling the isTransferable method of
the GSSContext class will indicate if the context object is the GSSContext interface will indicate if the context object is
transferable. transferable.
3.7. The Use of Incomplete Contexts 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 October 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 security libraries contain a provider architecture Moreover, the Java Cryptographic Architecture (JCA) defines a
that allows applications to be independent of the implementations of provider model which allows an implementation independent access to
the security API's they use. Using this model, applications can its security services. Using this model, applications can seamlessly
seamlessly switch between different implementations at runtime in switch between different implementations and dynamically add new
order to get support for different mechanisms. services. The GSS-API specification leverages these concepts by the
usage of providers for 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 8. of this API should import this package name as shows in section 7.
GSS-API implementors will have their implementation specific classes
that are not defined in this document reside in other packages. The
GSSManager class insulates the user from knowledge of these provider
specific packages.
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. The applications to be implementation independent and security API
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 to the names of the actual vendor classes that security services that are available to the names of the actual
implement those services. When requesting a service, an application vendor classes that implement those services. When requesting a
simply specifies the desired provider and the API classes delegate service, an application simply specifies the desired provider and the
the request to the appropriate provider class. API delegates the request to service classes available from that
provider.
Providers of the Java GSS-API should map the property GSS-API Java Bindings October 1999
"org.ietf.JGSS.GSSFactory" to the fully qualified name of their
implementation of the GSSFactory class. As explained later in
section 4.1 this class is the bootstrapping class for every GSS
provider and will allow the framework to obtain references to the
other classes that encapsulate the GSS services.
Using the Java security provider model insulates applications from Using the Java security provider model insulates applications from
implementation details of the providers they wish to use. The implementation details of the services they wish to use.
benefits of this approach are that applications can switch between Applications can switch between providers easily and new providers
providers transparently and new providers can be added as needed. can be added as needed, even at runtime.
Binary compatibility is maintained and applications can switch
providers even at runtime. The providers themselves can change The GSS-API may use providers to find components for specific
their implementation without having existing applications break. underlying security mechanisms. For instance, a particular provider
might contain components that will allow the GSS-API to support the
Kerberos v5 mechanism and another might contain components to support
the SPKM mechanism. By delegating mechanism specific functionality
to the components obtained from providers the GSS-API can be extended
to support an arbitrary list of mechanism.
How the GSS-API locates and queries these providers is beyond the
scope of this document and is being deferred to a Service Provider
Interface (SPI) specification. The availability of such a SPI
specification is not mandatory for the adoption of this API
specification nor is it mandatory to use providers in the
implementation of a GSS-API framework. However, by using the provider
framework together with an SPI specification one can create an
extensible and implementation independent GSS-API framework.
4.3. Integer types 4.3. Integer types
All numeric values are declared as "int" primitive Java type. The All numeric values are declared as "int" primitive Java type. The
Java specification guarantees that this will be a 32 bit two's Java specification guarantees that this will be a 32 bit two's
complement signed number. complement signed number.
Throughout this API, the "boolean" primitive Java type is used Throughout this API, the "boolean" primitive Java type is used
wherever a boolean value is required or returned. wherever a boolean value is required or returned.
skipping to change at page 15, line 48 skipping to change at page 16, line 4
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 October 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 48 skipping to change at page 17, line 4
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 October 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
skipping to change at page 17, line 27 skipping to change at page 17, line 31
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 IGSSCredential 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 IGSSContext object allows the value of "null" to The creation's of an GSSContext object allows the value of "null" to
be specified as the IGSSCredential 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 1) If there is only a single principal capable of initiating
security contexts for the chosen mechanism that the security contexts for the chosen mechanism that the
application is authorized to act on behalf of, then that application is authorized to act on behalf of, then that
principal shall be used, otherwise principal shall be used, otherwise
2) If the platform maintains a concept of a default network- 2) If the platform maintains a concept of a default network-
identity for the chosen mechanism, and if the application identity for the chosen mechanism, and if the application
is authorized to act on behalf of that identity for the is authorized to act on behalf of that identity for the
purpose of initiating security contexts, then the principal purpose of initiating security contexts, then the principal
corresponding to that identity shall be used, otherwise corresponding to that identity shall be used, otherwise
3) If the platform maintains a concept of a default local 3) If the platform maintains a concept of a default local
GSS-API Java Bindings October 1999
identity, and provides a means to map local identities into identity, and provides a means to map local identities into
network-identities for the chosen mechanism, and if the network-identities for the chosen mechanism, and if the
application is authorized to act on behalf of the network- application is authorized to act on behalf of the network-
identity image of the default local identity for the identity image of the default local identity for the
purpose of initiating security contexts using the chosen purpose of initiating security contexts using the chosen
mechanism, then the principal corresponding to that mechanism, then the principal corresponding to that
identity shall be used, otherwise identity shall be used, otherwise
4) A user-configurable default identity should be used. 4) A user-configurable default identity should be used.
skipping to change at page 18, line 39 skipping to change at page 18, line 43
any principal that the application is authorized to accept any principal that the application is authorized to accept
security contexts under using the chosen mechanism may be security contexts 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 IGSSCredential object representing a ones that instantiate an GSSCredential object representing a specific
specific identity. identity.
4.9. Contexts 4.9. Contexts
The IGSSContext 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 October 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 19, line 47 skipping to change at page 19, line 51
opaque octet-string, generated by the GSS-API in one process for use opaque octet-string, generated by the GSS-API in one process for use
by the GSS-API in another process. The calling application is by the GSS-API in another process. The calling application is
responsible for transferring such tokens between processes. Note responsible for transferring such tokens between processes. Note
that, while GSS-API implementors are encouraged to avoid placing that, while GSS-API implementors are encouraged to avoid placing
sensitive information within 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 IGSSContext byte array emitted from the export method of the GSSContext
interface. The receiver of the interprocess token would use interface. The receiver of the interprocess token would initialize
initialize an IGSSContext object with this token to create a new
context. Once a context has been exported, the IGSSContext object is GSS-API Java Bindings October 1999
invalidated and is no longer available.
an GSSContext object with this token to create a new context. Once a
context has been exported, the GSSContext object is invalidated and
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 2078 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.
skipping to change at page 20, line 37 skipping to change at page 20, line 41
GSS status codes indicate errors that are independent of the GSS status codes indicate errors that are independent of the
underlying mechanism(s) used to provide the security service. The underlying mechanism(s) used to provide the security service. The
errors that can be indicated via a GSS status code are generic API errors that can be indicated via a GSS status code are generic API
routine errors (errors that are defined in the GSS-API routine errors (errors that are defined in the GSS-API
specification). These bindings take advantage of the Java exceptions specification). These bindings take advantage of the Java exceptions
mechanism, thus eliminating the need for calling errors. mechanism, thus eliminating the need for calling errors.
A GSS status code indicates a single fatal generic API error from the A GSS status code indicates a single fatal generic API error from the
routine that has thrown the GSSException. Using exceptions announces routine that has thrown the GSSException. Using exceptions announces
that a fatal error has occurred during the execution of the method. that a fatal error has occurred during the execution of the method.
Two GSS-API routines can also return supplementary status information The GSS-API operational model also allows for the signaling of
which indicates non-fatal errors. These are handled as return values supplementary status information from the per-message calls. These
since using exceptions is not appropriate for informatory or need to be handled as return values since using exceptions is not
warning-like information. The methods that are capable of producing appropriate for informatory or warning-like information. The methods
supplementary information are the two per-message methods that are capable of producing supplementary information are the two
IGSSContext.verifyMIC() and IGSSContext.unwrap(). These methods fill per-message methods GSSContext.verifyMIC() and GSSContext.unwrap().
the supplementary status codes in the MessageProp object that was These methods fill the supplementary status codes in the MessageProp
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 October 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 Name Value Meaning
BAD_MECH 1 An unsupported mechanism BAD_MECH 1 An unsupported mechanism
was requested. was requested.
skipping to change at page 21, line 50 skipping to change at page 22, line 4
CONTEXT_EXPIRED 12 The context has expired. CONTEXT_EXPIRED 12 The context has expired.
FAILURE 13 Miscellaneous failure, FAILURE 13 Miscellaneous failure,
unspecified at the GSS-API level. unspecified at the GSS-API level.
BAD_QOP 14 The quality-of-protection BAD_QOP 14 The quality-of-protection
requested could not be provided. requested could not be provided.
UNAUTHORIZED 15 The operation is forbidden by UNAUTHORIZED 15 The operation is forbidden by
GSS-API Java Bindings October 1999
local security policy. 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.
skipping to change at page 22, line 27 skipping to change at page 22, line 31
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.
4.12.2. Mechanism-specific status codes 4.12.2. Mechanism-specific status codes
The GSSException thrown from a GSS-API method may originate from the Mechanism-specific status codes are communicated in two ways, they
mechanism independent layer or the mechanism specific layer. In the are part of any GSSException thrown from the mechanism specific layer
latter case, the exception will be used to indicate not only the to signal a fatal error, or they are part of the MessageProp object
major error codes but also the mechanism specific error code. that the per-message calls use to signal non-fatal errors.
A default value of 0 will be used to represent the absence of the A default value of 0 in either the GSSException object or the
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 IGSSContext interface. Because of the informative nature of the GSSContext interface. Because of the informative nature of these
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 IGSSContext interface Instead, the per-message operations of the GSSContext interface
return these values in a MessageProp object. return these values in a MessageProp object.
The MessageProp class defines query methods which return boolean The MessageProp class defines query methods which return boolean
values indicating the following supplementary states: values indicating the following supplementary states:
GSS-API Java Bindings October 1999
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.
skipping to change at page 23, line 36 skipping to change at page 23, line 41
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 IGSSName 1) A GSS-API form represented by implementations of the GSSName
interface: A single IGSSName object may contain multiple names interface: A single GSSName object may contain multiple names
from different namespaces, but all names should refer to the from different namespaces, but all names should refer to the
same entity. An example of such an internal name would be the same entity. An example of such an internal name would be the
name returned from a call to the getName method of the name returned from a call to the getName method of the
IGSSCredential interface, when applied to a credential GSSCredential interface, when applied to a credential containing
containing credential elements for multiple authentication credential elements for multiple authentication mechanisms
mechanisms employing different namespaces. This IGSSName object employing different namespaces. This GSSName object will
will contain a distinct name for the entity for each contain a distinct name for the entity for each authentication
authentication mechanism. mechanism.
GSS-API Java Bindings October 1999
For GSS-API implementations supporting multiple namespaces, For GSS-API implementations supporting multiple namespaces,
IGSSName 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 IGSSName 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 containing only a single name (from a single namespace). of 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 their format is dependent on the authentication mechanism and their format is dependent on the authentication mechanism
that employs that name. The string name forms are assumed to be that 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 IGSSName interface). returned from the export method of the GSSName interface).
An IGSSName object can be converted to a contiguous representation by An 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 IGSSName 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 There is no guarantee that calling the toString method on the GSSName
IGSSName interface will produce the same string form as the original interface will produce the same string form as the original imported
imported string name. Furthermore, it is possible that the name was string name. Furthermore, it is possible that the name was not even
not even constructed from a string representation. The same applies constructed from a string representation. The same applies to name-
to name- space identifiers which may not necessarily survive space identifiers which may not necessarily survive unchanged after a
unchanged after a journey through the internal name-form. An example journey through the internal name-form. An example of this might be
of this might be a mechanism that authenticates X.500 names, but a mechanism that authenticates X.500 names, but provides an
provides an algorithmic mapping of Internet DNS names into X.500. algorithmic mapping of Internet DNS names into X.500. That
That mechanism's implementation of IGSSName might, when presented mechanism's implementation of GSSName might, when presented with a
with a DNS name, generate an internal name that contained both the DNS name, generate an internal name that contained both the original
original DNS name and the equivalent X.500 name. Alternatively, it DNS name and the equivalent X.500 name. Alternatively, it might only
might only store the X.500 name. In the latter case, the toString store the X.500 name. In the latter case, the toString method of
method of IGSSName would most likely generate a printable X.500 name, GSSName would most likely generate a printable X.500 name, rather
rather than the original DNS name. than the original DNS name.
The context acceptor can obtain an IGSSName object representing the The context acceptor can obtain an GSSName object representing the
entity performing the context initiation (through the usage of entity performing the context initiation (through the usage of
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 IGSSContext internal name presented by the context initiator to the GSSContext
GSS-API Java Bindings October 1999
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 IGSSContext 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
dealing with an existing IGSSName object, the canonicalize method may dealing with an existing GSSName object, the canonicalize method may
be invoked to convert a general internal name into an MN. be invoked to convert a general internal name into an MN.
IGSSName objects can be compared using their equal method, which GSSName objects can be compared using their equal method, which
returns "true" if the two names being compared refer to the same returns "true" if the two names being compared refer to the same
entity. This is the preferred way to perform name comparisons entity. This is the preferred way to perform name comparisons
instead of using the printable names that a given GSS-API instead of using the printable names that a given GSS-API
implementation may support. Since GSS-API assumes that all primitive implementation may support. Since GSS-API assumes that all primitive
names contained within a given internal name refer to the same names contained within a given internal name refer to the same
entity, equal can return "true" if the two names have at least one entity, equal can return "true" if the two names have at least one
primitive name in common. If the implementation embodies knowledge primitive name in common. If the implementation embodies knowledge
of equivalence relationships between names taken from different of equivalence relationships between names taken from different
namespaces, this knowledge may also allow successful comparisons of namespaces, this knowledge may also allow successful comparisons of
internal names containing no overlapping primitive elements. internal names containing no overlapping primitive elements.
When used in large access control lists, the overhead of creating an When used in large access control lists, the overhead of creating an
IGSSName object on each name and invoking the equal method on each GSSName object on each name and invoking the equal method on each
name from the ACL may be prohibitive. As an alternative way of name from the ACL may be prohibitive. As an alternative way of
supporting this case, GSS-API defines a special form of the supporting this case, GSS-API defines a special form of the
contiguous byte array name which may be compared directly (byte by contiguous byte array name which may be compared directly (byte by
byte). Contiguous names suitable for comparison are generated by the byte). Contiguous names suitable for comparison are generated by the
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 IGSSName name will also be a MN. object identifier. The resulting GSSName name will also be a MN.
The IGSSName 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].
Note that the results obtained by using the equals method will in Note that the results obtained by using the equals method will in
general be different from those obtained by invoking canonicalize and general be different from those obtained by invoking canonicalize and
export, and then comparing the byte array output. The first series export, and then comparing the byte array output. The first series
of operation determines whether two (unauthenticated) names identify of operation determines whether two (unauthenticated) names identify
the same principal; the second whether a particular mechanism would the same principal; the second whether a particular mechanism would
authenticate them as the same principal. These two operations will authenticate them as the same principal. These two operations will
in general give the same results only for MNs. in general give the same results only for MNs.
It is important to note that the above are guidelines as how IGSSName GSS-API Java Bindings October 1999
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 IGSSName interface as long as the behavior satisfies the above of the GSSName interface as long as the behavior satisfies the above
guidelines. guidelines.
4.14. Channel Bindings 4.14. Channel Bindings
GSS-API supports the use of user-specified tags to identify a given GSS-API supports the use of user-specified tags to identify a given
context to the peer application. These tags are intended to be used context to the peer application. These tags are intended to be used
to identify the particular communications channel that carries the to identify the particular communications channel that carries the
context. Channel bindings are communicated to the GSS-API using the context. Channel bindings are communicated to the GSS-API using the
ChannelBinding object. The application may use byte arrays to ChannelBinding object. The application may use byte arrays to
specify the application data to be used in the channel binding as specify the application data to be used in the channel binding as
well as using instances of the InetAddress. The InetAddress for the well as using instances of the InetAddress. The InetAddress for the
initiator and/or acceptor can be used within an instance of a initiator and/or acceptor can be used within an instance of a
ChannelBinding. ChannelBinding can be set for the IGSSContext 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 IGSSContext object, "null" been used to set the ChannelBinding for an 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
by init method of the IGSSContext class. The same bindings are set by init method of the GSSContext interface. The same bindings are
by the context acceptor for its IGSSContext object and during set by the context acceptor for its GSSContext object and during
processing of the accept method a MIC is calculated in the same way. processing of the accept method a MIC is calculated in the same way.
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
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
GSS-API Java Bindings October 1999
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
expected to contain the usual GSS-API tokens which would otherwise be expected to contain the usual GSS-API tokens which would otherwise be
handled through the usage of byte arrays. The tokens are expected to handled through the usage of byte arrays. The tokens are expected to
have a definite start and an end. The callers are responsible for have a definite start and an end. The callers are responsible for
skipping to change at page 27, line 32 skipping to change at page 27, line 36
java.io package or creating their own through the use of inheritance. java.io package or creating their own through the use of inheritance.
This will allow for the application's greatest flexibility. This will allow for the application's greatest flexibility.
4.16. Optional Parameters 4.16. Optional Parameters
Whenever the application wishes to omit an optional parameter the Whenever the application wishes to omit an optional parameter the
"null" value shall be used. The detailed method descriptions "null" value shall be used. The detailed method descriptions
indicate which parameters are optional. Methods overloading has also indicate which parameters are optional. Methods overloading has also
been used as a technique to indicate default parameters. been used as a technique to indicate default parameters.
5. GSS Provider's Interface 5. Introduction to GSS-API Classes and Interfaces
This section presents a brief description of the interfaces that
encapsulate the services provided by a GSS-API implementator. They
are part of a framework presented in this document that will allow an
application to switch between different providers at runtime, by
enabling the framework to access the desired provider's
implementation via these interfaces.
The API in this section is meant primarily for GSS implementors. The This section presents a brief description of the classes and
GSS-API user does not need to obtain direct references to the classes interfaces that constitute the GSS-API. The implementations of these
implementing these interfaces. In fact, doing so might make the are obtained from the CLASSPATH defined by the application. If Java
application dependent on that particular implementation. GSS becomes part of the standard Java API's then these classes will
Applications that distribute a bundled GSS-API implementation along be available by default on all systems as part of the JRE's system
with them can use this API to avoid providing the concrete class classes.
wrappers in the framework. However, for applications that expect to
use a system-wide GSS library, it is envisioned that the callers will
utilize the wrapper classes of section 6 as the method of choice for
the creation of GSS-API objects.
This section also shows the corresponding RFC 2078 functionality This section also shows the corresponding RFC 2078 functionality
implemented by each of the interfaces. Detailed description of these implemented by each of the classes. Detailed description of these
interfaces and their methods is presented in section 7. classes and their methods is presented in section 6.
5.1. GSSFactory interface GSS-API Java Bindings October 1999
This interface represents the bootstrapping class that is supplied 5.1. GSSManager class
with every GSS-API provider and encapsulates information that is
specific to that particular provider. It contains factory methods to This class serves as a factory to instantiate implementations of the
obtain references to implementations of the other interfaces from the GSS-API interfaces and also provides methods to make queries about
provider. GSSFactory also handles all queries which would require a underlying security mechanisms. How this class locates and
knowledge of the list of underlying mechanisms that is supported by communicates with components from the underlying security mechanisms
the particular provider. It contains equivalents of the following is outside the scope of this document, but may be specified in
RFC 2078 routines: whatever SPI the GSSManager implementation follows.
Applications that desire to provide their own implementation of the
GSSManager class can simply extend the standard GSSManager class and
instantiate the new subclass. However, it is recommended that rather
than replacing the implementation, they enable the existing
implementation to support their needs by providing the necessary
components via the SPI that it follows.
This class contains equivalents of the following RFC 2078 routines:
RFC 2078 Routine Function Section RFC 2078 Routine Function Section
gss_indicate_mechs List the mechanisms 7.1.10 gss_import_name Create an internal name from 6.1.9-
the supplied information. 6.1.12
gss_acquire_cred Acquire credential 6.1.13-
for use. 6.1.15
gss_import_sec_context Create a previously exported 6.1.18
context.
gss_indicate_mechs List the mechanisms 6.1.6
supported by this GSS-API supported by this GSS-API
implementation. implementation.
gss_inquire_mechs_for_name List the mechanisms 7.1.11 gss_inquire_mechs_for_name List the mechanisms 6.1.8
supporting the supporting the
specified name type. specified name type.
gss_inquire_names_for_mech List the name types 7.1.12 gss_inquire_names_for_mech List the name types 6.1.7
supported by the supported by the
specified mechanism. specified mechanism.
5.2. IGSSName 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
IGSSName interface. Different name formats and their definitions are
GSS-API Java Bindings October 1999
GSSName interface. Different name formats and their definitions are
identified with universal Object Identifiers (oids). The format of identified with universal Object Identifiers (oids). The format of
the names can be derived based on the unique oid of each name type. the names can be derived based on the unique oid of each name type.
The following GSS-API routines are provided by the IGSSName The following GSS-API routines are provided by the GSSName interface:
interface:
RFC 2078 Routine Function Section(s) RFC 2078 Routine Function Section(s)
gss_import_name Create an internal name from 7.1.1-7.1.4 gss_display_name Covert internal name 6.2.7
the supplied information.
gss_display_name Covert internal name 7.2.6
representation to text format. representation to text format.
gss_compare_name Compare two internal names. 7.2.2, 7.2.3 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 7.1.3, 7.2.4 gss_canonicalize_name Convert an internal name to a 6.1.11,
mechanism name. mechanism name.
gss_export_name Convert a mechanism name to 7.2.5 gss_export_name Convert a mechanism name to 6.2.6
export format. export format.
gss_duplicate_name Create a copy of the internal N/A gss_duplicate_name Create a copy of the internal N/A
name. name.
The gss_release_name call is not provided as Java does its own The gss_release_name call is not provided as Java does its own
garbage collection. The gss_duplicate_name call is also redundant; garbage collection. The gss_duplicate_name call is also redundant;
the IGSSName interface has no mutator methods that can change the the GSSName interface has no mutator methods that can change the
state of the object, and so long as there is a reference to it, the state of the object so it is safe for sharing.
object will not be released by the JVM.
5.3. IGSSCredential interface 5.3. GSSCredential interface
The IGSSCredential 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 IGSSCredential 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 2078 Routine Function Section(s)
gss_acquire_cred Acquire credential for use. 7.1.5-7.1.7 gss_add_cred Constructs credentials 6.3.12
gss_add_cred Constructs credentials 7.3.11
incrementally. incrementally.
gss_inquire_cred Obtain information about 7.3.3- GSS-API Java Bindings October 1999
gss_inquire_cred Obtain information about 6.3.4,6.3.5
credential. credential.
gss_inquire_cred_by_mech Obtain per-mechanism 7.3.3-7.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 7.3.2 gss_release_cred Disposes of credentials 6.3.3
after use. after use.
5.4. IGSSContext 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 IGSSContext 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 2078 Routine Function Section(s)
gss_init_sec_context Initiate the creation of a 7.4.2, gss_init_sec_context Initiate the creation of a 6.4.3,
security context with 7.4.3 security context with a peer. 6.4.4
a peer.
gss_accept_sec_context Accept a security context 7.4.4, gss_accept_sec_context Accept a security context 6.4.5,
initiated by a peer. 7.4.5 initiated by a peer. 6.4.6
gss_delete_sec_context Destroy a security context. 7.4.7 gss_delete_sec_context Destroy a security context. 6.4.8
gss_context_time Obtain remaining context 7.4.36 gss_context_time Obtain remaining context 6.4.37
time. time.
gss_inquire_context Obtain context 7.3.38 to gss_inquire_context Obtain context 6.4.29 to
characteristics. 7.3.43 characteristics. 6.3.42
gss_wrap_size_limit Determine token-size limit 7.4.8 gss_wrap_size_limit Determine token-size limit 6.4.9
for gss_wrap. for gss_wrap.
gss_export_sec_context Transfer security context 7.4.17 gss_export_sec_context Transfer security context 6.4.18
to another process. to another process.
gss_import_sec_context Create a previously exported 7.1.10 GSS-API Java Bindings October 1999
context.
gss_get_mic Calculate a cryptographic 7.4.13, gss_get_mic Calculate a cryptographic 6.4.14,
Message Integrity Code (MIC) 7.4.14 Message Integrity Code (MIC) 6.4.15
for a message. for a message.
gss_verify_mic Verify integrity on a received 7.4.15, gss_verify_mic Verify integrity on a received 6.4.16,
message. 7.4.16 message. 6.4.17
gss_wrap Attach a MIC to a message and 7.4.9, gss_wrap Attach a MIC to a message and 6.4.10,
optionally encrypt the message 7.4.10 optionally encrypt the message 6.4.11
content. content.
gss_unwrap Obtain a previously wrapped 7.4.11, gss_unwrap Obtain a previously wrapped 6.4.12,
application message verifying 7.4.12 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 the RFC 2078 update
draft. IGSSContext does offer the functionality of destroying the draft. GSSContext does offer the functionality of destroying the
locally-stored context information. locally-stored context information.
6. GSS Application Programmer's Classes 5.5. MessageProp class
This section presents a brief description of the classes that a
typical application would use. The implementations of these classes
are picked from the CLASSPATH defined by the application. If Java
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
classes.
These classes are primarily part of a framework and do not provide
any of the security services themselves. The classes that provide
the security services are those that a provider can plug into this
framework as described in sections 4.2 and 5. Some classes described
here delegate their calls to the appropriate implementation class
from the provider.
This section also shows the corresponding RFC 2078 functionality
implemented by each of the interfaces. Detailed description of these
interfaces and their methods is presented in section 7.
6.1. GSSManager class
This class contains methods to interrogate a provider's GSSFactory
object. It also provides a means for a single point of control to
set the preferred GSS-API provider. All delegation done by the
GSSContext, GSSCredential and GSSName classes is then directed to
implementing classes for that provider by default.
Implementions of this class can locate and instantiate a provider
with the help of the java.Security.getProvider() method. They can
query the provider for the "org.ietf.JGSS.GSSFactory" property which
returns the name of that provider's GSSFactory implementation.
By encapsulating this behaviour in this class an application can
seamlessly switch between GSS-API implementations at runtime by
simply identifying a new provider to the GSSManager.
It contains the equivalents of the following RFC 2078 routines to
query the provider's GSSFactory: gss_indicate_mechs,
gss_inquire_mechs_for_name, gss_inquire_names_for_mech.
6.2. GSSName class
This concrete class is a wrapper around the interface IGSSName. It
provides all the methods that are defined in the IGSSName interface
and associated constructors. It uses the preferred GSS-API provider
and its GSSFactory to instantiate an IGSSName implementation and then
delegate all calls to it.
6.3. GSSCredential class
This concrete class is a wrapper around the interface IGSSCredential.
It provides all the methods that are defined in the IGSSCredential
interface and associated constructors. It uses the preferred GSS-API
provider and its GSSFactory to instantiate an IGSSCredential
implementation and then delegate all calls to it.
6.4. GSSContext class
This concrete class is a wrapper around the interface IGSSContext.
It provides all the methods that are defined in the IGSSContext
interface and associated constructors. It uses the preferred GSS-API
provider and its GSSFactory to instantiate an IGSSContext
implementation and then delegate all calls to it.
6.5. MessageProp class
This helper class is used in the per-message operations on the This helper class is used in the per-message operations on the
context. An instance of this class is created by the application and context. An instance of this class is created by the application and
then passed into the per-message calls. In some cases, the then passed into the per-message calls. In some cases, the
application conveys information to the GSS-API implementation through application conveys information to the GSS-API implementation through
this object and in other cases the GSS-API returns information to the this object and in other cases the GSS-API returns information to the
application by setting it in this object. See the description of the application by setting it in this object. See the description of the
per-message operations wrap, unwrap, getMIC, and verifyMIC in the per-message operations wrap, unwrap, getMIC, and verifyMIC in the
IGSSContext interfaces for details. GSSContext interfaces for details.
6.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.
GSS-API Java Bindings October 1999
RFC 2078 Routine Function Section RFC 2078 Routine Function Section
gss_display_status Retrieve textual 7.8.5, 7.8.6, gss_display_status Retrieve textual 6.8.5, 6.8.6,
representation of error 7.8.8, 7.8.9 representation of error 6.8.8, 6.8.9
codes. codes.
6.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 2078 Routine Function Section
gss_test_oid_set_member Determine if the specified oid 7.7.6 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.
6.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 IGSSContext 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
use instances of the InetAddress. InetAddress is currently the only use instances of the InetAddress. 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 that only one supported within the ChannelBinding class. Applications that
use other types of addresses can include them as part of the use other types of addresses can include them as part of the
application data. application data.
7. Detailed GSS-API Class Description 6. Detailed GSS-API Class Description
This section lists a detailed description of all the public methods This section lists a detailed description of all the public methods
that each of the GSS-API classes and interfaces must provide. that each of the GSS-API classes and interfaces must provide.
7.1. public interface GSSFactory 6.1. public class GSSManager
This interface provides factory methods to obtain provider specific The GSSManager is a concrete class that serves as a factory for three
implementations of the interfaces IGSSCredential, IGSSName, and GSS interfaces: GSSName, GSSCredential, and GSSContext. It also
IGSSContext. It also contains other functionality that requires
implementation specific knowledge and cannot be placed cleanly in any
of the other interfaces.
Each GSS-API provider defines a class that implements this interface. GSS-API Java Bindings October 1999
Applications can instantiate the provider's implementation of
GSSFactory if they are aware of the qualified name of that class.
However, in the interest of portability applications are advised to
go through the GSSManager API instead. The GSSFactory interface is
primarily meant for GSS implementors and for developers who bundle a
custom GSS-API implementation together with their application. Such
applications may choose not to implement the GSSManager class along
with the other wrappers such as GSSName, GSSCredential, and
GSSContext. They would then directly instantiate and use the
interfaces described in section 5.
7.1.1. createName provides methods for applications to determine what mechanisms are
available on the system and what nametypes these mechanisms support.
public IGSSName createName(String nameStr, Oid nameSpace) The GSSManager class may be internally implemented as a modular
provider based layer that follows some service provider specification
to lookup underlying mechanism components. It provides the
application with a method to set a preferred provider for any given
mechanism.
6.1.1. Example Code
GSSManager mgr = new GSSManager();
// What mechs are available to us?
Oid[] supportedMechs = mgr.getMechs();
// Set a preference for the provider to be used when support is need
// for the mechanisms "1.2.840.113554.1.2.2" and "1.3.6.1.5.5.2".
// Assume this provider (called "Sun") has already been installed on
// the system.
Oid krb = new Oid("1.2.840.113554.1.2.2");
Oid spnego = new Oid("1.3.6.1.5.5.2");
mgr.setProvider(krb, "Sun");
mgr.setProvider(spnego, "Sun");
// Add support for a new mechanism "1.3.6.1.5.5.1.1" that is
// available from a specific provider being bundled with the
// application.
Oid spkm1 = new Oid("1.3.6.1.5.5.1.1");
Provider prov = (Provider) (new com.foo.security.Provider());
mgr.setProvider(spkm1, prov);
// What name types does this spkm implementation support?
Oid[] nameTypes = mgr.getNamesForMech(spkm1);
6.1.2. Constructors
public GSSManager()
GSS-API Java Bindings October 1999
Constructor which instantiates a GSSManager for the application.
6.1.3. setProvider
public void setProvider(Oid mech, String provName)
throws GSSException, java.security.NoSuchProviderException
Sets the provider for the GSS-API to use internally when it needs
components to support the indicated mechanism.
If the GSSManager implementation does not support an SPI with a
pluggable provider architecture it should throw a GSSException with
the status code GSSException.UNAVAILABLE to indicate that the
operation is unavailable. If the requested provider does not support
the indicated mech then it should throw a GSSException with the
status code GSSException.BAD_MECH.
This call assumes that the provider defined by the string provName is
already installed on the system either statically or dynamically
using the Java Cryptography Architecture (JCA) specification. If it
does not find the provider it should throw a NoSuchProviderException.
Parameters:
mech The mechanism for which the provider is being set
provName The name of the provider that should be used whenever
support is needed for mech. A value of null will
remove any previous preference set by the application.
6.1.4. setProvider
public void setProvider(Oid mech, java.security.Provider p)
throws GSSException
Sets the provider for the GSS-API to use internally when it needs
components to support the indicated mechanism.
If the GSSManager implementation does not support an SPI with a
pluggable provider architecture it should throw a GSSException with
the status code GSSException.UNAVAILABLE to indicate that the
operation is unavailable. If the requested provider does not support
the indicated mech then it should throw a GSSException with the
status code GSSException.BAD_MECH.
GSS-API Java Bindings October 1999
This provider need not be installed globally on the system at all.
The application instantiates the provider and passes it to the
instance of GSSManager through this method.
Parameters:
mech The mechanism for which the provider is being set
p The provider instance to be used to implement the
services for the specified mechanism. A value of null
will remove any previous preference set by the
application.
6.1.5. getProvider
public Provider getProvider(Oid mech)
Returns the preferred Provider instance that the GSS-API would use
when trying to instantiate elements for the indicated mechanism.
6.1.6. getMechs
public Oid[] getMechs()
Returns an array of Oid objects indicating mechanisms available to
GSS-API callers. A "null" value is returned when no mechanism are
available (an example of this would be when mechanism are dynamically
configured, and currently no mechanisms are installed).
6.1.7. getNamesForMech
public Oid[] getNamesForMech(Oid mech)
throws GSSException
Returns name type Oid's supported by the specified mechanism.
Parameters:
mech The Oid object for the mechanism to query.
GSS-API Java Bindings October 1999
6.1.8. getMechsForName
public Oid[] getMechsForName(Oid nameType)
Returns an array of Oid objects corresponding to the mechanisms that
support the specific name type. "null" is returned when no
mechanisms are found to support the specified name type.
Parameters:
nameType The Oid object for the name type.
6.1.9. createName
public GSSName createName(String nameStr, Oid nameSpace)
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 IGSSName object. In general, the IGSSName object namespace to an 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 nameType The Oid specifying the namespace of the printable name
supplied. Note that nameType serves to describe and supplied. Note that nameType serves to describe and
qualify the interpretation of the input nameStr, it qualify the interpretation of the input nameStr, it
does not necessarily imply a type for the output does not necessarily imply a type for the output
IGSSName implementation. "null" value can be used to GSSName implementation. "null" value can be used to
specify that a mechanism specific default printable specify that a mechanism specific default printable
syntax should be assumed by each mechanism that syntax should be assumed by each mechanism that
examines nameStr. examines nameStr.
7.1.2. createName 6.1.10. createName
public IGSSName createName(byte name[], Oid nameType) public 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 IGSSName object. In general, the
IGSSName object created will not be an MN; two examples that are GSS-API Java Bindings October 1999
from the specified namespace to an GSSName object. In general, the
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. in the byte array. Note that nameType serves to
Note that nameType serves to describe and qualify the describe and qualify the interpretation of the input
interpretation of the input name byte array, it does not name byte array, it does not necessarily imply a type
necessarily imply a type for the output IGSSName implementation. for the output GSSName implementation. "null" value
"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 that examines default syntax should be assumed by each mechanism
the byte array..IP "nameType" 10 The Oid specifying the that examines the byte array.
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
IGSSName implementation. "null" value can be used to specify
that a mechanism specific default printable syntax should be
assumed by each mechanism that examines nameStr.
7.1.3. createName 6.1.11. createName
public IGSSName createName(String nameStr, Oid nameType, public GSSName createName(String nameStr, Oid nameType,
Oid mechType) throws GSSException Oid mechType) 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 IGSSName 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 7.1.1 and then also the steps: the createName described in 6.1.7 and then also the
IGSSName.canonicalize() described in 7.2.4. 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 nameType The Oid specifying the namespace of the printable name
supplied. Note that nameType serves to describe and supplied. Note that nameType serves to describe and
qualify the interpretation of the input nameStr, it qualify the interpretation of the input nameStr, it
does not necessarily imply a type for the output does not necessarily imply a type for the output
IGSSName implementation. "null" value can be used to GSSName implementation. "null" value can be used to
specify that a mechanism specific default printable specify that a mechanism specific default printable
syntax should be assumed when the mechanism examines syntax should be assumed when the mechanism examines
nameStr. nameStr.
mechType Oid specifying the mechanism for which this name mechType Oid specifying the mechanism for which this name
should be created. should be created.
7.1.4. createName GSS-API Java Bindings October 1999
6.1.12. createName
public createName(byte name[], Oid nameType, Oid mechType) public createName(byte name[], Oid nameType, Oid mechType)
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 IGSSName object that is an MN. In from the specified namespace to an 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 7.1.2 and then also the steps: the createName described in 6.1.8 and then also the
IGSSName.canonicalize() described in 7.2.4. 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 IGSSName 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 mechType Oid specifying the mechanism for which this name
should be created. should be created.
7.1.5. createCredential 6.1.13. createCredential
public IGSSCredential createCredential (int usage) public 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 an INDEFINITE 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: value of this parameter must be one of:
IGSSCredential.ACCEPT_AND_INITIATE, GSSCredential.ACCEPT_AND_INITIATE,
IGSSCredential.ACCEPT_ONLY, GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
IGSSCredential.INITIATE_ONLY
7.1.6. createCredential 6.1.14. createCredential
public GSSCredential createCredential (GSSName aName,
GSS-API Java Bindings October 1999
public IGSSCredential createCredential (IGSSName aName,
int lifetime, Oid mechOid, int usage) int lifetime, Oid mechOid, 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 IGSSCredential.INDEFINITE to request that valid. Use GSSCredential.INDEFINITE to request that
the credentials have the maximum permitted lifetime. the credentials have the maximum permitted lifetime.
mechOid The oid of the desired mechanism. Use "(Oid) null" to mechOid 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:
IGSSCredential.ACCEPT_AND_INITIATE, GSSCredential.ACCEPT_AND_INITIATE,
IGSSCredential.ACCEPT_ONLY, GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
IGSSCredential.INITIATE_ONLY
7.1.7. createCredential 6.1.15. createCredential
public IGSSCredential createCredential(IGSSName aName, public 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
IGSSCredential.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. principal.
lifetime The number of seconds that credentials should remain lifetime The number of seconds that credentials should remain
valid. Use IGSSCredential.INDEFINITE to request that valid. Use GSSCredential.INDEFINITE to request that
the credentials have the maximum permitted lifetime. the credentials have the maximum permitted lifetime.
mechOid The array of mechanisms over which the credential is mechOid 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
GSS-API Java Bindings October 1999
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:
IGSSCredential.ACCEPT_AND_INITIATE, GSSCredential.ACCEPT_AND_INITIATE,
IGSSCredential.ACCEPT_ONLY, GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
IGSSCredential.INITIATE_ONLY
7.1.8. createContext 6.1.16. createContext
public IGSSContext createContext(IGSSName peer, Oid mechOid, public GSSContext createContext(GSSName peer, Oid mechOid,
IGSSCredential 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 IGSSContext.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 mechOid 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 credential.
7.1.9. createContext 6.1.17. createContext
public IGSSContext createContext(IGSSCredential myCred) public GSSContext createContext(GSSCredential myCred)
throws GSSException throws GSSException
Factory method for creating a context on the acceptor' side. The Factory method for creating a context on the acceptor' side. The
context's properties will be determined from the input token supplied context's properties will be determined from the input token supplied
to the accept method. to the accept method.
Parameters: Parameters:
myCred Credentials for the acceptor. Use "null" to act as a myCred Credentials for the acceptor. Use "null" to act as a
default acceptor principal. default acceptor principal.
7.1.10. createContext GSS-API Java Bindings October 1999
public IGSSContext createContext(byte [] interProcessToken) 6.1.18. createContext
public 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.
7.1.11. getMechs 6.2. public interface GSSName
public Oid[] getMechs()
Returns an array of Oid objects, one for each mechanism available
through this GSS-API implementation. A "null" value is returned when
no mechanism are available (an example of this would be when
mechanism are dynamically configured, and currently no mechanisms are
installed).
7.1.12. getMechsForName This interface encapsulates a single GSS-API principal entity.
Different name formats and their definitions are identified with
universal Object Identifiers (Oids). The format of the names can be
derived based on the unique oid of its namespace type.
public Oid[] getMechsForName(Oid nameType) 6.2.1. Example Code
Returns an array of Oid objects, one for each mechanism that supports Included below are code examples utilizing the GSSName interface.
the specific namespace type. "null" is returned when no mechanisms The code below creates a GSSName, converts it to a mechanism name
are found to support the specified namespace type. (MN), performs a comparison, obtains a printable representation of
the name, exports it and then re-imports to obtain a new GSSName.
Parameters: GSSManager mgr = new GSSManager();
nameType The Oid object for the namespace type // create a host based service name
GSSName name = mgr.createName("service@host",
GSSName.NT_HOSTBASED_SERVICE);
7.1.13. getNamesForMech Oid krb5 = new Oid("1.2.840.113554.1.2.2");
public Oid[] getNamesForMech(Oid mech) throws GSSException GSSName mechName = name.canonicalize(krb5);
Returns the Oid's for the various types of namespaces that are // the above two steps are equivalent to the following
supported by the specified mechanism. GSSName mechName = mgr.createName("service@host",
GSSName.NT_HOSTBASED_SERVICE, krb5);
Parameters: // perform name comparison
if (name.equals(mechName))
mech The Oid for the mechanism to query. GSS-API Java Bindings October 1999
7.2. public interface IGSSName extends java.security.Principal print("Names are equals.");
This interface encapsulates a single GSS-API principal entity. // obtain textual representation of name and its printable
Different name formats and their definitions are identified with // name type
universal Object Identifiers (Oids). The format of the names can be print(mechName.toString() +
derived based on the unique oid of its namespace type. mechName.getStringNameType().toString());
This interface extends the java.security.Principal interface which // export and re-import the name
represents the more abstract notion of an entity in Java. With byte [] exportName = mechName.export();
IGSSName extending this standard java interface, we achieve a tighter
integration of GSS-API names with java objects. Applications may use
this to their benefit in instances where a GSS name can be passed as
a java security name, for instance, to a repository of principal
names.
The java.security.Principal.getName() method of a class implementing // create a new name object from the exported buffer
the IGSSName interface is expected to return the same String as the GSSName newName = mgr.createName(exportName,
toString() method would, which is the equivalent of the GSSName.NT_EXPORT_NAME);
gss_display_name() call.
7.2.1. Static Constants 6.2.2. Static Constants
public static final Oid NT_HOSTBASED_SERVICE public static final Oid NT_HOSTBASED_SERVICE
Oid indicating a host-based service name form. It is used to Oid indicating a host-based service name form. It is used to
represent services associated with host computers. This name form is represent services associated with host computers. This name form is
constructed using two elements, "service" and "hostname", as follows: constructed using two elements, "service" and "hostname", as follows:
service@hostname service@hostname
Values for the "service" element are registered with the IANA. It Values for the "service" element are registered with the IANA. It
skipping to change at page 41, line 39 skipping to change at page 43, line 5
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
GSS-API Java Bindings October 1999
Name type to indicate a string of digits representing the numeric Name type to indicate a string of digits representing the numeric
user identifier of a user on a local system. It represents the user identifier of a user on a local system. It represents the
following value: { iso(1) member-body(2) United States(840) following value: { iso(1) member-body(2) United States(840)
mit(113554) infosys(1) gssapi(2) generic(1) string_uid_name(3) } mit(113554) infosys(1) gssapi(2) generic(1) string_uid_name(3) }
public static final Oid NT_ANONYMOUS public static final Oid NT_ANONYMOUS
Name type for representing an anonymous entity. It represents the Name type for representing an anonymous entity. It represents the
following value: { 1(iso), 3(org), 6(dod), 1(internet), 5(security), following value: { 1(iso), 3(org), 6(dod), 1(internet), 5(security),
6(nametypes), 3(gss-anonymous-name) } 6(nametypes), 3(gss-anonymous-name) }
public static final Oid NT_EXPORT_NAME public static final Oid NT_EXPORT_NAME
Name type used to indicate an exported name produced by the export Name type used to indicate an exported name produced by the export
method. It represents the following value: { 1(iso), 3(org), 6(dod), method. It represents the following value: { 1(iso), 3(org), 6(dod),
1(internet), 5(security), 6(nametypes), 4(gss-api-exported-name) } 1(internet), 5(security), 6(nametypes), 4(gss-api-exported-name) }
skipping to change at page 42, line 14 skipping to change at page 43, line 24
Name type for representing an anonymous entity. It represents the Name type for representing an anonymous entity. It represents the
following value: { 1(iso), 3(org), 6(dod), 1(internet), 5(security), following value: { 1(iso), 3(org), 6(dod), 1(internet), 5(security),
6(nametypes), 3(gss-anonymous-name) } 6(nametypes), 3(gss-anonymous-name) }
public static final Oid NT_EXPORT_NAME public static final Oid NT_EXPORT_NAME
Name type used to indicate an exported name produced by the export Name type used to indicate an exported name produced by the export
method. It represents the following value: { 1(iso), 3(org), 6(dod), method. It represents the following value: { 1(iso), 3(org), 6(dod),
1(internet), 5(security), 6(nametypes), 4(gss-api-exported-name) } 1(internet), 5(security), 6(nametypes), 4(gss-api-exported-name) }
7.2.2. equals 6.2.3. equals
public boolean equals(IGSSName another) throws GSSException public boolean equals(GSSName another) throws GSSException
Compares two IGSSName 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.
7.2.3. equals 6.2.4. equals
public boolean equals(Object another) public boolean equals(Object another)
A variation of the equals method described in 7.2.2 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 7.2.2 will inherit. The behaviour 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. returned in the situation where an error occurs.
Parameters: Parameters:
another GSSName object to compare with. another GSSName object to compare with.
7.2.4. canonicalize GSS-API Java Bindings October 1999
public IGSSName canonicalize(Oid mechOid) throws GSSException 6.2.5. canonicalize
public GSSName canonicalize(Oid mechOid) 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 7.1.3 or is equivalent to using the factory methods described in 6.1.9 or
7.1.4 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 authentication mechanism for which the mechOid The oid for the mechanism for which the canonical form
canonical form of the name is requested. of the name is requested.
7.2.5. 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 outputted buffer is export it. The format of the header of the output buffer is
specified in RFC 2078. specified in RFC 2078.
7.2.6. 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
string, the getStringNameType method can be used. string, the getStringNameType method can be used.
7.2.7. 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.
7.2.8. isAnonymous GSS-API Java Bindings October 1999
6.2.9. isAnonymous
public boolean isAnonymous() public boolean isAnonymous()
Tests if this name object represents an anonymous entity. Returns Tests if this name object represents an anonymous entity. Returns
"true" if this is an anonymous name. "true" if this is an anonymous name.
7.2.9. 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 2078.
7.3. public interface IGSSCredential 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.
skipping to change at page 44, line 35 skipping to change at page 45, line 44
callers to prevent unauthorized callers from acquiring credentials to callers to prevent unauthorized callers from acquiring credentials to
which they are not entitled. GSS-API credential creation is not which they are not entitled. GSS-API credential creation is not
intended to provide a "login to the network" function, as such a intended to provide a "login to the network" function, as such a
function would involve the creation of new credentials rather than function would involve the creation of new credentials rather than
merely acquiring a handle to existing credentials. Such functions, merely acquiring a handle to existing credentials. Such functions,
if required, should be defined in implementation-specific extensions if required, should be defined in implementation-specific extensions
to the API. to the API.
If credential acquisition is time-consuming for a mechanism, the If credential acquisition is time-consuming for a mechanism, the
mechanism may choose to delay the actual acquisition until the mechanism may choose to delay the actual acquisition until the
credential is required (e.g. by IGSSContext). Such mechanism- credential is required (e.g. by GSSContext). Such mechanism-
specific implementation decisions should be invisible to the calling specific implementation decisions should be invisible to the calling
application; thus the query methods immediately following the application; thus the query methods immediately following the
creation of a credential object must return valid credential data, creation of a credential object must return valid credential data,
and may therefore incur the overhead of a deferred credential and may therefore incur the overhead of a deferred credential
acquisition. acquisition.
Applications will create a credential object passing the desired Applications will create a credential object passing the desired
GSS-API Java Bindings October 1999
parameters. The application can then use the query methods to obtain parameters. The application can then use the query methods to obtain
specific information about the instantiated credential object specific information about the instantiated credential object
(equivalent to the gss_inquire routines). When the credential is no (equivalent to the gss_inquire routines). When the credential is no
longer needed, the application should call the dispose (equivalent to longer needed, the application should call the dispose (equivalent to
gss_release_cred) method to release any resources held by the gss_release_cred) method to release any resources held by the
credential object and to destroy any cryptographically sensitive credential object and to destroy any cryptographically sensitive
information. information.
Classes implementing this interface also implement the Cloneable Classes implementing this interface also implement the Cloneable
interface. This indicates the the class will support the clone() interface. This indicates the the class will support the clone()
method that will allow the creation of duplicate credentials. This method that will allow the creation of duplicate credentials. This
is useful when called just before the add() call to retain a copy of is useful when called just before the add() call to retain a copy of
the original credential. the original credential.
7.3.1. Static Constants 6.3.1. Example Code
This example code demonstrates the creation of a GSSCredential
implementation for a specific entity, querying of its fields, and its
release when it is no longer needed.
GSSManager mgr = new GSSManager();
// start by creating a name object for the entity
GSSName name = mgr.createName("userName", GSSName.NT_USER_NAME);
// now acquire credentials for the entity
GSSCredential cred = mgr.createCredential(name,
GSSCredential.ACCEPT_ONLY);
// display credential information - name, remaining lifetime,
// and the mechanisms it has been acquired over
print(cred.getName().toString());
print(cred.getRemainingLifetime());
Oid [] mechs = cred.getMechs();
if (mechs != null) {
for (int i = 0; i < mechs.length; i++)
print(mechs[i].toString());
}
// release system resources held by the credential
cred.dispose();
GSS-API Java Bindings October 1999
6.3.2. Static Constants
public static final int INITIATE_AND_ACCEPT public static final int INITIATE_AND_ACCEPT
Credential usage flag requesting that it be able to be used for both Credential usage flag requesting that it be able to be used for both
context initiation and acceptance. context initiation and acceptance.
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.
skipping to change at page 45, line 34 skipping to change at page 47, line 30
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 INDEFINITE
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.
7.3.2. dispose 6.3.3. dispose
public void dispose() throws GSSException public void dispose() throws GSSException
Releases any sensitive information that the IGSSCredential 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.
7.3.3. getName 6.3.4. getName
public GSSName getName() throws GSSException
public IGSSName getName() throws GSSException
Retrieves the name of the entity that the credential asserts. Retrieves the name of the entity that the credential asserts.
7.3.4. getName 6.3.5. getName
public IGSSName getName(Oid mechOID) throws GSSException public GSSName getName(Oid mechOID) throws GSSException
GSS-API Java Bindings October 1999
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.
7.3.5. 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 IGSSCredential.INDEFINITE credential mechanisms. A return value of GSSCredential.INDEFINITE
indicates that the credential does not expire. A return value of 0 indicates that the credential does not expire. A return value of 0
indicates that the credential is already expired. indicates that the credential is already expired.
7.3.6. 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 IGSSCredential.INDEFINITE indicates mechanism. A return value of GSSCredential.INDEFINITE indicates that
that the credential does not expire for context initiation. A return the credential does not expire for context initiation. A return
value of 0 indicates that the credential is already expired. 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.
7.3.7. 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 IGSSCredential.INDEFINITE indicates mechanism. A return value of GSSCredential.INDEFINITE indicates that
that the credential does not expire for context acceptance. A return the credential does not expire for context acceptance. A return
value of 0 indicates that the credential is already expired. value of 0 indicates that the credential is already expired.
Parameters: Parameters:
GSS-API Java Bindings October 1999
mechOID The mechanism for which information should be mechOID The mechanism for which information should be
returned. returned.
7.3.8. 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
IGSSCredential.INITIATE_ONLY, IGSSCredential.ACCEPT_ONLY, or GSSCredential.INITIATE_ONLY, GSSCredential.ACCEPT_ONLY, or
IGSSCredential.INITIATE_AND_ACCEPT. GSSCredential.INITIATE_AND_ACCEPT.
7.3.9. 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
IGSSCredential.INITIATE_ONLY, IGSSCredential.ACCEPT_ONLY, or GSSCredential.INITIATE_ONLY, GSSCredential.ACCEPT_ONLY, or
IGSSCredential.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.
7.3.10. 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.
7.3.11. 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.
GSS-API Java Bindings October 1999
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.
skipping to change at page 48, line 41 skipping to change at page 50, line 37
credentials have the maximum permitted lifetime. credentials have the maximum permitted lifetime.
mechOid The mechanisms over which the credential is to be mechOid 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
7.3.12. equals 6.3.13. equals
public boolean equals(Object another) public boolean equals(Object another)
Tests if this IGSSCredential refers to the same entity as the Tests if this GSSCredential refers to the same entity as the supplied
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.
Parameters: Parameters:
another Another IGSSCredential object for comparison. another Another GSSCredential object for comparison.
7.4. public interface IGSSContext GSS-API Java Bindings October 1999
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
calling application to transport its tokens between peers. calling application to transport its tokens between peers.
skipping to change at page 50, line 6 skipping to change at page 52, line 5
After the context has been established or the isProtReady() method After the context has been established or the isProtReady() method
returns "true", the query routines can be invoked to determine the returns "true", the query routines can be invoked to determine the
actual characteristics and services of the established context. The actual characteristics and services of the established context. The
application can also start using the per-message methods of wrap and application can also start using the per-message methods of wrap and
getMIC to obtain cryptographic operations on application supplied getMIC to obtain cryptographic operations on application supplied
data. data.
When the context is no longer needed, the application should call When the context is no longer needed, the application should call
dispose to release any system resources the context may be using. dispose to release any system resources the context may be using.
7.4.1. Static Constants GSS-API Java Bindings October 1999
6.4.1. Example Code
The example code presented below demonstrates the usage of the
GSSContext interface for the initiating peer. Different operations
on the GSSContext object are presented, including: object
instantiation, setting of desired flags, context establishment, query
of actual context flags, per-message operations on application data,
and finally context deletion.
GSSManager mgr = new GSSManager();
// start by creating the name for a service entity
GSSName targetName = mgr.createName("service@host",
GSSName.NT_HOSTBASED_SERVICE);
// create a context using default credentials for the above entity
// and the implementation specific default mechanism
GSSContext context = mgr.createContext(targetName,
null, /* default mechanism */
null, /* default credentials */
GSSContext.INDEFINITE);
// set desired context options - all others are false by default
context.requestConf(true);
context.requestMutualAuth(true);
context.requestReplayDet(true);
context.requestSequenceDet(true);
// establish a context between peers - using byte arrays
byte []inTok = new byte[0];
try {
do {
byte[] outTok = context.initSecContext(inTok, 0,
inTok.length);
// send the token if present
if (outTok != null)
sendToken(outTok);
// check if we should expect more tokens
if (context.isEstablished())
break;
// another token expected from peer
inTok = readToken();
GSS-API Java Bindings October 1999
} while (true);
} catch (GSSException e) {
print("GSSAPI error: " + e.getMessage());
}
// display context information
print("Remaining lifetime in seconds = " + context.getLifetime());
print("Context mechanism = " + context.getMech().toString());
print("Initiator = " + context.getSrcName().toString());
print("Acceptor = " + context.getTargName().toString());
if (context.getConfState())
print("Confidentiality security service available");
if (context.getIntegState())
print("Integrity security service available");
// perform wrap on an application supplied message, appMsg,
// using QOP = 0, and requesting privacy service
byte [] appMsg ...
MessageProp mProp = new MessageProp(0, true);
byte []tok = context.wrap(appMsg, 0, appMsg.length, mProp);
if (mProp.getPrivacy())
print("Message protected with privacy.");
sendToken(tok);
// release the local-end of the context
context.dispose();
6.4.2. Static Constants
public static final int INDEFINITE public static final int INDEFINITE
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.
7.4.2. initSecContext GSS-API Java Bindings October 1999
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. "null" return value indicates that no token needs to be
skipping to change at page 51, line 5 skipping to change at page 54, line 40
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).
7.4.2.1. Example Code 6.4.3.1. Example Code
// Create a new IGSSContext implementation object. // Create a new GSSContext implementation object.
// GSSContext wrapper implements interface IGSSContext. // GSSContext wrapper implements interface GSSContext.
IGSSContext context = new GSSContext(...); 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,
GSS-API Java Bindings October 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;
// another token expected from peer // another token expected from peer
inTok = readToken(); inTok = readToken();
} while (true); } while (true);
} catch (GSSException e) { } catch (GSSException e) {
print("GSSAPI error: " + e.getMessage()); print("GSSAPI error: " + e.getMessage());
} }
7.4.3. 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. 0 bytes written to the output stream indicate that no
token needs to be sent to the peer. The application can call token needs to be sent to the peer. The application can call
skipping to change at page 52, line 18 skipping to change at page 56, line 5
needs to be sent to the peer, but the local end of the context is now needs to be sent to the peer, but the local end of the context is now
fully established. 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.
GSS-API Java Bindings October 1999
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.
7.4.3.1. Example Code 6.4.4.1. Example Code
// Create a new IGSSContext implementation object. // Create a new GSSContext implementation object.
// GSSContext wrapper implements interface IGSSContext. // GSSContext wrapper implements interface GSSContext.
IGSSContext context = new GSSContext(...); 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 {
context.init(is, os); context.initSecContext(is, os);
// send token if present // send token if present
if (os.size() > 0) if (os.size() > 0)
sendToken(os); sendToken(os);
// 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);
} catch (GSSException e) { } catch (GSSException e) {
print("GSSAPI error: " + e.getMessage()); print("GSSAPI error: " + e.getMessage());
} }
7.4.4. acceptSecContext GSS-API Java Bindings October 1999
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.
This call is equivalent to the stream based method except that the This call is equivalent to the stream based method except that the
token buffers are handled as byte arrays instead of using stream token buffers are handled as byte arrays instead of using stream
objects. objects.
This method may return an output token which the application will This method may return an output token which the application will
skipping to change at page 54, line 5 skipping to change at page 57, line 42
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).
7.4.4.1. Example Code 6.4.5.1. Example Code
// acquire server credentials // acquire server credentials
IGSSCredential server = new GSSCredential(...); GSSCredential server = mgr.createCredential(...);
// create acceptor GSS-API context fromthe default provider // create acceptor GSS-API context fromthe default provider
IGSSContext context = new GSSContext(server, null); GSSContext context = mgr.createContext(server, null);
try { try {
do { do {
byte [] inTok = readToken(); byte [] inTok = readToken();
byte []outTok = context.accept(inTok, 0, GSS-API Java Bindings October 1999
byte []outTok = context.acceptSecContext(inTok, 0,
inTok.length); inTok.length);
// possibly send token to peer // possibly send token to peer
if (outTok != null) if (outTok != null)
sendToken(outTok); sendToken(outTok);
// 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());
} }
7.4.5. 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 outStreamf, 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. 0 bytes
written to the output stream indicate that no token needs to be sent written to the output stream indicate that no token needs to be sent
to the peer. The application can call isEstablished() to determine to the peer. The application can call isEstablished() to determine
if the context establishment phase is complete for this peer. A if the context establishment phase is complete for this peer. A
return value of "false" from isEstablished() indicates that more return value of "false" from isEstablished() indicates that more
tokens are expected to be supplied to this method. 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
skipping to change at page 55, line 17 skipping to change at page 59, line 5
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. inStream Contains the token generated by the peer.
GSS-API Java Bindings October 1999
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.
7.4.5.1. Example Code 6.4.6.1. Example Code
// acquire server credentials // acquire server credentials
IGSSCredential server = new GSSCredential(...); GSSCredential server = mgr.createCredential(...);
// create acceptor GSS-API context fromthe default provider // create acceptor GSS-API context fromthe default provider
IGSSContext context = new GSSContext(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 56, line 4 skipping to change at page 59, line 38
context.acceptSecContext(is, os); context.acceptSecContext(is, os);
// possibly send token to peer // possibly send token to peer
if (os.size() > 0) if (os.size() > 0)
sendToken(os); sendToken(os);
// 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());
} }
7.4.6. 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.
GSS-API Java Bindings October 1999
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.
7.4.7. dispose 6.4.8. dispose
public void dispose() throws GSSException public void dispose() throws GSSException
Releases any system resources and cryptographic information stored in Releases any system resources and cryptographic information stored in
the context object. This will invalidate the context. the context object. This will invalidate the context.
7.4.8. getWrapSizeLimit 6.4.9. getWrapSizeLimit
public int getWrapSizeLimit(int qop, boolean confReq, public int getWrapSizeLimit(int qop, boolean confReq,
int maxTokenSize) throws GSSException int maxTokenSize) throws GSSException
Returns the maximum message size that, if presented to the wrap Returns the maximum message size that, if presented to the wrap
method with the same confReq and qop parameters, will result in an method with the same confReq and qop parameters, will result in an
output token containing no more than the maxTokenSize bytes. output token containing no more than the maxTokenSize bytes.
This call is intended for use by applications that communicate over This call is intended for use by applications that communicate over
protocols that impose a maximum message size. It enables the protocols that impose a maximum message size. It enables the
skipping to change at page 57, line 18 skipping to change at page 61, line 5
qop Indicates the level of protection wrap will be asked qop Indicates the level of protection wrap will be asked
to provide. 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.
7.4.9. wrap GSS-API Java Bindings October 1999
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
byte array will contain both the MIC and the message. byte array will contain both the MIC and the message.
skipping to change at page 58, line 15 skipping to change at page 61, line 50
len The length of the data within the inBuf (starting at len The length of the data within the inBuf (starting at
the offset). the offset).
msgProp Instance of MessageProp that is used by the msgProp Instance of MessageProp that is used by the
application to set the desired QOP and privacy state. application to set the desired QOP and privacy state.
Set the desired QOP to 0 to request the default QOP. Set the desired QOP to 0 to request the default QOP.
Upon return from this method, this object will contain Upon return from this method, this object will contain
the the actual privacy state that was applied to the the the actual privacy state that was applied to the
message by the underlying mechanism. message by the underlying mechanism.
7.4.10. 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
GSS-API Java Bindings October 1999
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.
The MessageProp object is instantiated by the application and used to The MessageProp object is instantiated by the application and used to
specify a QOP value which selects cryptographic algorithms, and a specify a QOP value which selects cryptographic algorithms, and a
privacy service to optionally encrypt the message. The underlying privacy service to optionally encrypt the message. The underlying
mechanism that is used in the call may not be able to provide the mechanism that is used in the call may not be able to provide the
privacy service. It sets the actual privacy service that it does privacy service. It sets the actual privacy service that it does
skipping to change at page 59, line 4 skipping to change at page 62, line 39
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. outStream The output stream to write the protected message to.
The application is responsible for sending this to the The application is responsible for sending this to the
other peer for processing in its unwrap method. other peer for processing in its unwrap method.
msgProp Instance of MessageProp that is used by the msgProp Instance of MessageProp that is used by the
application to set the desired QOP and privacy state. application to set the desired QOP and privacy state.
Set the desired QOP to 0 to request the default QOP. Set the desired QOP to 0 to request the default QOP.
Upon return from this method, this object will contain Upon return from this method, this object will contain
the the actual privacy state that was applied to the the the actual privacy state that was applied to the
message by the underlying mechanism. message by the underlying mechanism.
7.4.11. 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.
GSS-API Java Bindings October 1999
The MessageProp object is instantiated by the application and is used The MessageProp object is instantiated by the application and is used
by the underlying mechanism to return information to the caller such by the underlying mechanism to return information to the caller such
as the QOP, whether confidentiality was applied to the message, and as the QOP, whether confidentiality was applied to the message, and
other supplementary message state information. other supplementary message state information.
Since some application-level protocols may wish to use tokens emitted Since some application-level protocols may wish to use tokens emitted
by wrap to provide "secure framing", implementations should support by wrap to provide "secure framing", implementations should support
the wrapping and unwrapping of zero-length messages. the wrapping and unwrapping of zero-length messages.
Parameters: Parameters:
skipping to change at page 59, line 44 skipping to change at page 63, line 31
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.
7.4.12. 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
skipping to change at page 60, line 21 skipping to change at page 64, line 5
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.
GSS-API Java Bindings October 1999
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.
7.4.13. 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.
skipping to change at page 61, line 14 skipping to change at page 64, line 47
len The length of the token within the inMsg (starting at len The length of the token within the inMsg (starting at
the offset). the offset).
msgProp Instance of MessageProp that is used by the msgProp Instance of MessageProp that is used by the
application to set the desired QOP. Set the 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.
7.4.14. 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
GSS-API Java Bindings October 1999
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.
skipping to change at page 61, line 45 skipping to change at page 65, line 32
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.
7.4.15. 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
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
skipping to change at page 62, line 21 skipping to change at page 66, line 5
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.
GSS-API Java Bindings October 1999
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".
7.4.16. 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
skipping to change at page 63, line 21 skipping to change at page 67, line 4
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
GSS-API Java Bindings October 1999
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".
7.4.17. 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
exchange. exchange.
This method deactivates the security context and creates an This method deactivates the security context and creates an
interprocess token which, when passed to the byte array constructor interprocess token which, when passed to the byte array constructor
of the GSSContext class in another process, will re-activate the of the GSSContext interface in another process, will re-activate the
context in the second process. Only a single instantiation of a context in the second process. Only a single instantiation of a
given context may be active at any one time; a subsequent attempt by given context may be active at any one time; a subsequent attempt by
a context exporter to access the exported security context will fail. a context exporter to access the exported security context will fail.
The implementation may constrain the set of processes by which the The implementation may constrain the set of processes by which the
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
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.
7.4.18. 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
GSS-API Java Bindings October 1999
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.
7.4.19. 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.
7.4.20. 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.
7.4.21. 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.
7.4.22. requestAnonymity GSS-API Java Bindings October 1999
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.
7.4.23. 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.
7.4.24. 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
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.
7.4.25. 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
GSS-API Java Bindings October 1999
the initiator. the initiator.
Parameters: Parameters:
lifetime The desired context lifetime in seconds. lifetime The desired context lifetime in seconds.
7.4.26. 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.
7.4.27. 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.
7.4.28. getMutualAuthState 6.4.29. getMutualAuthState
public boolean getMutualAuthState() public boolean getMutualAuthState()
Returns the state of the mutual authentication option for the Returns the state of the mutual authentication option for the
context. When issued before context establishment completes or when context. When issued before context establishment completes or when
the isProtReady method returns "false", it returns the desired state, the isProtReady method returns "false", it returns the desired state,
otherwise it will indicate the actual state over the established otherwise it will indicate the actual state over the established
context. context.
7.4.29. getReplayDetState 6.4.30. getReplayDetState
public boolean getReplayDetState() public boolean getReplayDetState()
Returns the state of the replay detection option for the context. Returns the state of the replay detection option for the context.
When issued before context establishment completes or when the When issued before context establishment completes or when the
isProtReady method returns "false", it returns the desired state, isProtReady method returns "false", it returns the desired state,
GSS-API Java Bindings October 1999
otherwise it will indicate the actual state over the established otherwise it will indicate the actual state over the established
context. context.
7.4.30. getSequenceDetState 6.4.31. getSequenceDetState
public boolean getSequenceDetState() public boolean getSequenceDetState()
Returns the state of the sequence detection option for the context. Returns the state of the sequence detection option for the context.
When issued before context establishment completes or when the When issued before context establishment completes or when the
isProtReady method returns "false", it returns the desired state, isProtReady method returns "false", it returns the desired state,
otherwise it will indicate the actual state over the established otherwise it will indicate the actual state over the established
context. context.
7.4.31. getAnonymityState 6.4.32. getAnonymityState
public boolean getAnonymityState() public boolean getAnonymityState()
Returns "true" if this is an anonymous context. When issued before Returns "true" if this is an anonymous context. When issued before
context establishment completes or when the isProtReady method context establishment completes or when the isProtReady method
returns "false", it returns the desired state, otherwise it will returns "false", it returns the desired state, otherwise it will
indicate the actual state over the established context. indicate the actual state over the established context.
7.4.32. 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.
7.4.33. 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.
7.4.34. getConfState 6.4.35. getConfState
public boolean getConfState() public boolean getConfState()
GSS-API Java Bindings October 1999
Returns the confidentiality service state over the context. When Returns the confidentiality service state over the context. When
issued before context establishment completes or when the isProtReady issued before context establishment completes or when the isProtReady
method returns "false", it returns the desired state, otherwise it method returns "false", it returns the desired state, otherwise it
will indicate the actual state over the established context. will indicate the actual state over the established context.
7.4.35. getIntegState 6.4.36. getIntegState
public boolean getIntegState() public boolean getIntegState()
Returns the integrity service state over the context. When issued Returns the integrity service state over the context. When issued
before context establishment completes or when the isProtReady method before context establishment completes or when the isProtReady method
returns "false", it returns the desired state, otherwise it will returns "false", it returns the desired state, otherwise it will
indicate the actual state over the established context. indicate the actual state over the established context.
7.4.36. getLifetime 6.4.37. getLifetime
public int getLifetime() public int getLifetime()
Returns the context lifetime in seconds. When issued before context Returns the context lifetime in seconds. When issued before context
establishment completes or when the isProtReady method returns establishment completes or when the isProtReady method returns
"false", it returns the desired lifetime, otherwise it will indicate "false", it returns the desired lifetime, otherwise it will indicate
the remaining lifetime for the context. the remaining lifetime for the context.
7.4.37. 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.
7.4.38. 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.
7.4.39. getMech 6.4.40. getMech
public Oid getMech() throws GSSException public Oid getMech() throws GSSException
GSS-API Java Bindings October 1999
Returns the mechanism oid for this context. Returns the mechanism oid for this context.
7.4.40. 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.
7.4.41. isInitiator 6.4.42. isInitiator
public boolean isInitiator() throws GSSException public boolean isInitiator() throws GSSException
Returns "true" if this is the initiator of the context. This call is Returns "true" if this is the initiator of the context. This call is
only valid after the context creation process has started. only valid after the context creation process has started.
7.5. public class MessageProp 6.5. public class MessageProp
This is a utility class used within the per-message GSSContext This is a utility class used within the per-message GSSContext
methods to convey per-message properties. methods to convey per-message properties.
When used with the IGSSContext interface's wrap and getMIC methods, When used with the GSSContext interface's wrap and getMIC methods, an
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 IGSSContext When used with the unwrap and verifyMIC methods of the GSSContext
interface, an instance of this class will be used to indicate the interface, an instance of this class will be used to indicate the
applied QOP and confidentiality services over the supplied message. applied QOP and confidentiality services over the supplied message.
In the case of verifyMIC, the confidentiality state will always be In the case of verifyMIC, the confidentiality state will always be
"false". Upon return from these methods, this object will also "false". Upon return from these methods, this object will also
contain any supplementary status values applicable to the processed contain any supplementary status values applicable to the processed
token. The supplementary status values can indicate old tokens, out token. The supplementary status values can indicate old tokens, out
of sequence tokens, gap tokens or duplicate tokens. of sequence tokens, gap tokens or duplicate tokens.
7.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
GSS-API Java Bindings October 1999
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.
7.5.2. getQOP 6.5.2. getQOP
public int getQOP() public int getQOP()
Retrieves the QOP value. Retrieves the QOP value.
7.5.3. getPrivacy 6.5.3. getPrivacy
public boolean getPrivacy() public boolean getPrivacy()
Retrieves the privacy state. Retrieves the privacy state.
7.5.4. setQOP 6.5.4. getMinorStatus
public int getMinorStatus()
Retrieves the minor status that the underlying mechanism might have
set.
6.5.5. getMinorString
public String getMinorString()
Returns a string explaining the mechanism specific error code. null
will be returned when no mechanism error code has been set.
GSS-API Java Bindings October 1999
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.
7.5.5. 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.
7.5.6. 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.
7.5.7. 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.
7.5.8. isUnseqToken 6.5.10. isUnseqToken
public boolean isUnseqToken() public boolean isUnseqToken()
Returns "true" if a later token has already been processed. Returns "true" if a later token has already been processed.
7.5.9. isGapToken 6.5.11. isGapToken
public boolean isGapToken() public boolean isGapToken()
GSS-API Java Bindings October 1999
Returns "true" if an expected per-message token was not received. Returns "true" if an expected per-message token was not received.
7.5.10. setSupplementaryStates 6.5.12. setSupplementaryStates
public void setSupplementaryStates(boolean duplicate, public void setSupplementaryStates(boolean duplicate,
boolean old, boolean unseq, boolean gap) boolean old, boolean unseq, boolean gap,
int minorStatus, String minorString)
This method sets the state for the supplementary information flags in This method sets the state for the supplementary information flags
MessageProp. It is not used by the application but by the GSS and the minor status in MessageProp. It is not used by the
implementation to return this information to the caller of a per- application but by the GSS implementation to return this information
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 old true if the token's validity period has expired, false
otherwise otherwise
unseq true if a later token has already been processed, unseq true if a later token has already been processed,
false otherwise false otherwise
gap true if one or more predecessor tokens have not yet gap true if one or more predecessor tokens have not yet
been succesfully processed, false otherwise been successfully processed, false otherwise
7.6. public class ChannelBinding minorStatus the integer minor status code that the underlying
mechanism wants to set
minorString the textual representation of the minorStatus
value
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.
The caller initiating the security context must determine the The caller initiating the security context must determine the
appropriate channel binding values to set in the GSSContext object. appropriate channel binding values to set in the GSSContext object.
GSS-API Java Bindings October 1999
The acceptor must provide an identical binding in order to validate The acceptor must provide an identical binding in order to validate
that received tokens possess correct channel-related characteristics. that received tokens possess correct channel-related characteristics.
Use of channel bindings is optional in GSS-API. Since channel- Use of channel bindings is optional in GSS-API. Since channel-
binding information may be transmitted in context establishment binding information may be transmitted in context establishment
tokens, applications should therefore not use confidential data as tokens, applications should therefore not use confidential data as
channel-binding components. channel-binding components.
7.6.1. Constructors 6.6.1. Constructors
public ChannelBinding(InetAddress initAddr, InetAddress acceptAddr, public ChannelBinding(InetAddress initAddr, InetAddress acceptAddr,
byte[] appData) byte[] appData)
Create a ChannelBinding object with user supplied address information Create a ChannelBinding object with user supplied address information
and data. "null" values can be used for any fields 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:
skipping to change at page 73, line 43 skipping to change at page 77, line 48
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.
7.6.2. getInitiatorAddress 6.6.2. getInitiatorAddress
public InetAddress getInitiatorAddress() public InetAddress getInitiatorAddress()
GSS-API Java Bindings October 1999
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.
7.6.3. getAcceptorAddress 6.6.3. getAcceptorAddress
public InetAddress getAcceptorAddress() public InetAddress getAcceptorAddress()
Returns the acceptor's address for this channel binding. "null" is Returns the acceptor's address for this channel binding. "null" is
returned if the address has not been set. returned if the address has not been set.
7.6.4. getApplicationData 6.6.4. getApplicationData
public byte[] getApplicationData() public byte[] getApplicationData()
Returns application data being used as part of the ChannelBinding. Returns application data being used as part of the ChannelBinding.
"null" is returned if no application data has been specified for the "null" is returned if no application data has been specified for the
channel binding. channel binding.
7.6.5. equals 6.6.5. equals
public boolean equals(Object obj) public boolean equals(Object obj)
Returns "true" if two channel bindings match. Returns "true" if two channel bindings match.
Parameters: Parameters:
obj Another channel binding to compare with. obj Another channel binding to compare with.
7.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
ISOIEC-8825. For example the Oid representation of Kerberos V5 ISOIEC-8825. For example the Oid representation of Kerberos V5
mechanism is "1.2.840.113554.1.2.2" mechanism is "1.2.840.113554.1.2.2"
The GSSName name class contains public static Oid objects The GSSName name class contains public static Oid objects
GSS-API Java Bindings October 1999
representing the standard name types defined in GSS-API. representing the standard name types defined in GSS-API.
7.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.
skipping to change at page 75, line 38 skipping to change at page 79, line 42
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.
7.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").
7.7.3. equals GSS-API Java Bindings October 1999
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.
Parameters: Parameters:
obj Another Oid object to compare with. obj Another Oid object to compare with.
7.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.
7.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:
oids An array of oids to search. oids An array of oids to search.
7.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
throwing this exception. throwing this exception.
All implementations are encouraged to use the Java All implementations are encouraged to use the Java
internationalization techniques to provide local translations of the internationalization techniques to provide local translations of the
message strings. message strings.
7.8.1. Static Constants GSS-API Java Bindings October 1999
6.8.1. Static Constants
All valid major GSS-API error code values are declared as constants All valid major GSS-API error code values are declared as constants
in this class. in this class.
public static final int BAD_BINDINGS public static final int BAD_BINDINGS
Channel bindings mismatch error. Channel bindings mismatch error.
public static final int BAD_MECH public static final int BAD_MECH
skipping to change at page 77, line 40 skipping to change at page 82, line 5
public static final int CONTEXT_EXPIRED public static final int CONTEXT_EXPIRED
Specified security context expired error. Specified security context expired error.
public static final int CREDENTIALS_EXPIRED public static final int CREDENTIALS_EXPIRED
Expired credentials detected error. Expired credentials detected error.
public static final int DEFECTIVE_CREDENTIAL public static final int DEFECTIVE_CREDENTIAL
GSS-API Java Bindings October 1999
Defective credential error. Defective credential error.
public static final int DEFECTIVE_TOKEN public static final int DEFECTIVE_TOKEN
Defective token error. Defective token error.
public static final int FAILURE public static final int FAILURE
General failure, unspecified at GSS-API level. General failure, unspecified at GSS-API level.
skipping to change at page 78, line 41 skipping to change at page 83, line 5
Operation unavailable error. Operation unavailable error.
public static final int DUPLICATE_ELEMENT public static final int DUPLICATE_ELEMENT
Duplicate credential element requested error. Duplicate credential element requested error.
public static final int NAME_NOT_MN public static final int NAME_NOT_MN
Name contains multi-mechanism elements error. Name contains multi-mechanism elements error.
GSS-API Java Bindings October 1999
public static final int DUPLICATE_TOKEN public static final int DUPLICATE_TOKEN
The token was a duplicate of an earlier token. This is a fatal error The token was a duplicate of an earlier token. This is a fatal error
code that may occur during context establishment. It is not used to code 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 OLD_TOKEN public static final int OLD_TOKEN
The token's validity period has expired. This is a fatal error code The token's validity period has expired. This is a fatal error code
skipping to change at page 79, line 29 skipping to change at page 83, line 35
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
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.
7.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
GSS-API Java Bindings October 1999
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.
7.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.
7.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
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.
7.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.
7.8.6. getMinorString 6.8.6. getMinorString
public String getMinorString() public String getMinorString()
Returns a string explaining the mechanism specific error code. An Returns a string explaining the mechanism specific error code. null
empty string will be returned when no mechanism error code has been will be returned when no mechanism error code has been set.
set.
7.8.7. setMinor GSS-API Java Bindings October 1999
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.
7.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.
7.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
obtain exception information. obtain exception information.
7.9. public abstract class GSSManager 7. Sample Applications
This class contains methods to manage and query different GSS-API
providers. This saves the application from knowing the name of the
provider's factory class and instantiating it. When the application
has multiple providers installed on its system, it can use the
GSSManager to search through them and return one that supports a
desired underlying mechanism. It also provides a means for a single
point of control to set the preferred GSS-API provider. All
delegation done by the GSSContext, GSSCredential and GSSName classes
is then directed to implementing classes for that provider by
default.
Because this class locates and instantiates providers using the
standard Java provider architecture, applications are encouraged to
make use of this class to maximize portability across implementations
rather than obtaining direct references to the factory classes from
the implementations.
The benefits of this approach are that applications can switch
between providers transparently and new providers can be added as
needed. Binary compatibility is maintained and applications can
switch providers even at runtime. The providers themselves can
change their implementation without having existing applications
break.
7.9.1. Example
// Import the Security class and the Provider class from
// the java security package
import java.security.Security;
import java.security.Provider;
// We want to use the GSS-API implementation from a provider that is
// registered with the system as FOOBAR.
Provider p = Security.getProvider("FOOBAR");
// What mechs does FOOBAR's GSS-API implementation support?
Oid[] supportedMechs = GSSManager.getMechs(p);
// Which provider is being used by default?
Provider p = GSSManager.getDefaultProvider();
print(p.getName()); // May not be "FOOBAR"
7.9.2. setDefaultProvider
public static void setDefaultProvider(Provider p)
throws java.security.NoSuchProviderException
Sets the desired provider for the GSSManager, and the wrapper classes
GSSName, GSSContext, and GSSCredential to use to delegate their calls
by default.
Parameters:
p The provider that should be used by default.
7.9.3. getDefaultProvider
public static Provider getDefaultProvider()
Returns a Provider object that represents the provider that the
GSSManager, and the wrapper classes GSSName, GSSContext, and
GSSCredential and using to delegate their calls to.
7.9.4. getMechs
public static Oid[] getMechs(Provider p)
Returns an array of Oid objects, one for each mechanism available
within the GSS-API implementation supplied by the indicated provider.
A "null" value is returned when no mechanism are available (an
example of this would be when mechanism are dynamically configured,
and currently no mechanisms are installed).
Parameters:
p The provider that should be queried. "null" indicates
query the default GSS-API provider.
7.9.5. getNamesForMech
public static Oid[] getNamesForMech(Oid mech, Provider p)
throws GSSException
Returns name types Oids supported by the specified mechanism.
Parameters:
mech The Oid object for the mechanism to query.
p The provider that should be queried. "null" indicates
query the default GSS-API provider.
7.9.6. getMechsForName
public static Oid[] getMechsForName(Oid nameType, Provider p)
Returns an array of Oid objects, one for each mechanisms that support
the specific name type. "null" is returned when no mechanisms are
found to support the specified name type.
Parameters:
nameType The Oid object for the name type to query.
p The provider that should be queried. "null" indicates
query the default GSS-API provider.
7.9.7. getProviderFromToken
public static Provider getProviderFromToken(byte[] firstToken)
Find a provider whose GSS-API implementation can support the
mechanism that is needed for accepting a context with the given
context establishment token. This call can be made only with the
first context establishment token received at the acceptor's end;
that token is required to follow the format defined in section 3.1 of
RFC 2078.
This call is useful to a context acceptor that has multiple GSS
implementations available to it and has to decide which one of them
to use such that the implementation supports the mechanism that the
context initiator wishes to use.
Parameters:
firstTokenThe first token that is emitted during a GSS-API
context establishment.
7.9.8. getProviderForMechanism
public static Provider[] getProvidersForMechanism(Oid mechOid)
A utility method to find the provider(s) whose GSS-API implementation
can support the given mechanism. The GSSManager class locates all
java security providers registered with the system and determines
from their respective GSSFactory implementations which ones support
this mechanism. It returns as array with all such provider objects.
An application can then choose a preferred provider from the returned
set.
Parameters:
mechOid The Oid of the desired mechanism.
7.10. public class GSSName implements IGSSName
This concrete class is a wrapper around the interface IGSSName. An
application can use the GSSName class to perform all functionality of
the IGSSName interface eliminating the need to know the interface and
instantiating it from the provider. Its constructor performs the
following in one step: obtain the provider specific factory
(IGSSFactory) object, and obtain an IGSSName object from the factory
initialized with the parameters supplied in the constructor. The
wrapper delegates all its calls to this provider specific IGSSName
object.
It uses the preferred GSS-API provider to instantiate the IGSSName
implementation to delegate to. A default provider can optionally be
set by the application with the GSSManager.setDefaultProvider() call.
The GSSName class implements the IGSSName interface and thus provides
for all its functionality and also passes the compiler's type
checking when used in place of IGSSName. The methods from IGSSName
that GSSName implements are:
public boolean equals(IGSSName another) throws GSSException
public boolean equals(Object another)
public IGSSName canonicalize(Oid mechOid) throws GSSException
public byte[] export() throws GSSException
public String toString()
public Oid getStringNameType() throws GSSException
public boolean isAnonymous()
public boolean isMN()
Similarly, it inherits the following static constants:
public static final Oid NT_HOSTBASED_SERVICE
public static final Oid NT_USER_NAME
public static final Oid NT_MACHINE_UID_NAME
public static final Oid NT_STRING_UID_NAME
public static final Oid NT_ANONYMOUS
public static final Oid NT_EXPORT_NAME
7.10.1. Example
Included below are code examples utilizing a GSSName object. The
code below creates a GSSName object, converts it to a mechanism name
(MN), performs a comparison, obtains a printable representation of
the name, exports it and then re-imports to obtain a new GSSName
object. This code uses the default GSS-API provider on the system.
// create an oid object for Kerberos v5 to export the name with
// Kerberos later on
Oid krb5 = new Oid("1.2.840.113554.1.2.2");
// create a host based service name
GSSName name = new GSSName("service@host",
GSSName.NT_HOSTBASED_SERVICE, null);
GSSName mechName = name.canonicalize(krb5);
// the above two steps are equivalent to the following constructor
GSSName mechName = new GSSName("service@host",
GSSName.NT_HOSTBASED_SERVICE, krb5, null);
// perform name comparison
if (name.equals(mechName))
print("Names are equals.");
// obtain textual representation of name and its printable
// name type
print(mechName.toString() +
mechName.getStringNameType().toString());
// export and re-import the name
byte [] exportName = mechName.export();
// create a new name object from the exported buffer
GSSName newName = new GSSName(exportName,
GSSName.NT_EXPORT_NAME, null);
7.10.2. Constructors
public GSSName(String nameStr, Oid nameSpace, Provider p)
throws GSSException
Converts a contiguous string name from the specified namespace to a
GSSName object. In general, the GSSName object created will not be
an MN; the exception to this is if the namespace type parameter
indicates NT_EXPORT_NAME or if the GSS-API implementation is not
multi-mechanism.
Parameters:
nameStr The string representing a printable form of the name
to create.
nameType The Oid specifying the namespace of the printable name
supplied. "null" value can be used to specify that a
mechanism specific default printable syntax should be
assumed by each mechanism that examines nameStr.
p The preferred provider whose GSS-API implementation
should be used. "null" indicates use the default GSS-
API provider.
public GSSName(byte name[], Oid nameType, Provider p)
throws GSSException
Converts a contiguous byte array containing a name from the specified
namespace to a GSSName object. In general, the GSSName object
created will not be an MN; the exception to this is if the namespace
type parameter indicates NT_EXPORT_NAME or if the GSS-API
implementation is not multi-mechanism.
Parameters:
name The byte array containing the name to create.
nameType The Oid specifying the namespace of the name supplied
in the byte array. "null" value can be used to specify
that a mechanism specific default syntax should be
assumed by each mechanism that examines the byte
array.
p The preferred provider whose GSS-API implementation
should be used. "null" indicates use the default
GSS-API provider.
public GSSName(String nameStr, Oid nameType, Oid mechType,
Provider p) throws GSSException
Converts a contiguous string name from the specified namespace to a
GSSName object that is a mechanism name (MN).
Parameters:
nameStr The string representing a printable form of the name
to create.
nameType The Oid specifying the namespace of the printable name
supplied. "null" value can be used to specify that a
mechanism specific default printable syntax should be
assumed when the mechanism examines nameStr.
mechType The Oid specifying the mechanism for which this name
should be created. "null" value can be used to
specify the default mechanism.
p The preferred provider whose GSS-API implementation
should be used. "null" indicates use the default GSS-
API provider. Implementations should then pick the
first registered provider on the system that supports
the mechanism mechType.
public GSSName(byte name[], Oid nameType, Oid mechType,
Provider p) throws GSSException
Converts a contiguous byte array containing a name from the specified
namespace to a GSSName object that is a mechanism name (MN).
Parameters:
name The byte array representing the name to create.
nameType The Oid specifying the namespace of the printable name
supplied. "null" value can be used to specify that a
mechanism specific default printable syntax should be
assumed when the mechanism examines nameStr.
mechType The Oid specifying the mechanism for which this name
should be created.
p The preferred provider whose GSS-API implementation
should be used. "null" indicates use the default GSS-
API provider. Implementations should then pick the
first registered provider on the system that supports
the mechanism mechType.
7.10.3. getProvider
public java.security.Provider getProvider()
Returns the provider of the IGSSName implementation that this GSSName
object is delegating all its calls to. This is useful for
applications to track which GSS implementation this object came from.
It is important to not pass an IGSSName implementation (which
contains provider specific internal elements) to an IGSSCredential or
IGSSContext implementation from another provider.
7.11. public class GSSCredential implements IGSSCredential
This concrete class is a wrapper around the interface IGSSCredential
An application can use the GSSCredential class to perform all
functionality of the IGSSCredential interface eliminating the need to
know the interface and instantiating it from the provider. Its
constructor performs the following in one step: obtain the provider
specific factory (IGSSFactory) object, and obtain an IGSSCredential
object from the factory initialized with the parameters supplied in
the constructor. The wrapper delegates all its calls to this
provider specific IGSSName object.
It uses the preferred GSS-API provider to instantiate the
IGSSCredential implementation to delegate to. A default provider can
optionally be set by the application with the
GSSManager.setDefaultProvider() call.
The GSSCredential class implements the IGSSCredential interface and
thus provides for all its functionality and also passes the
compiler's type checking when used in place of IGSSCredential. The
methods from IGSSCredential that GSSCredential implements are:
public void dispose() throws GSSException
public IGSSName getName() throws GSSException
public IGSSName getName(Oid mechOID) throws GSSException
public int getRemainingLifetime() throws GSSException
public int getRemainingInitLifetime(Oid mech)
throws GSSException
public int getRemainingAcceptLifetime(Oid mech)
throws GSSException
public int getUsage() throws GSSException
public int getUsage(Oid mechOID) throws GSSException
public Oid[] getMechs() throws GSSException
public void add(GSSName aName, int initLifetime,
int acceptLifetime, Oid mech,
int usage) throws GSSException
public boolean equals(Object another)
Similarly, it inherits the following static constants:
public static final int INITIATE_AND_ACCEPT
public static final int INITIATE_ONLY
public static final int ACCEPT_ONLY
public static final int INDEFINITE
7.11.1. Example
This example code demonstrates the creation of a GSSCredential object
for a specific entity, querying of its fields, and its release when
it is no longer needed. It uses the default GSS provider.
// start by creating a name object for the entity
GSSName name = new GSSName("userName", GSSName.NT_USER_NAME, null);
// now create a credential for the entity
GSSCredential cred = new GSSCredential(name,
GSSCredential.ACCEPT_ONLY, null);
// display credential information - name, remaining lifetime,
// and the mechanisms it has been acquired over
print(cred.getName().toString());
print(cred.getRemainingLifetime());
Oid [] mechs = cred.getMechs();
if (mechs != null) {
for (int i = 0; i < mechs.length; i++)
print(mechs[i].toString());
}
// release system resources held by the credential
cred.dispose();
7.11.2. Constructors
public GSSCredential (int usage, Provider p) throws GSSException
Constructor for GSSCredential that acquires default credentials.
This will cause the GSS-API to use system specific defaults for the
set of mechanisms, name, and an INDEFINITE lifetime.
Parameters are:
usage The intended usage for this credential object. The
value of this parameter must be one of:
GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
p The preferred provider whose GSS-API implementation
should be used. "null" indicates use the default GSS-
API provider.
public GSSCredential (IGSSName aName, int lifetime,
Oid mechOid, int usage, Provider p)
throws GSSException
Constructor for GSSCredential that acquires a single mechanism
credential.
Parameters:
aName Name of the principal for whom this credential is to
be acquired. Use "null" to specify the default
principal.
lifetime The number of seconds that credentials should remain
valid. Use GSSCredential.INDEFINITE to request that
the credentials have the maximum permitted lifetime.
mechOid The oid of the desired mechanism. Use "(Oid) null" to
request the default mechanism(s).
usage The intended usage for this credential object. The
value of this parameter must be one of:
GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
p The preferred provider whose GSS-API implementation
should be used. "null" indicates use the default GSS-
API provider.
public GSSCredential(IGSSName aName, int lifetime,
Oid mechs[], int usage, Provider p)
throws GSSException
Constructor for GSSCredential that acquires credentials over a set of
mechanisms. Acquires credentials for each of the mechanisms
specified in the array called mechs. To determine the list of
mechanisms' for which the acquisition of credentials succeeded, the
caller should use the GSSCredential.getMechs() method.
Parameters:
aName Name of the principal for whom this credential is to
be acquired. Use "null" to specify the default
principal.
lifetime The number of seconds that credentials should remain
valid. Use GSSCredential.INDEFINITE to request that
the credentials have the maximum permitted lifetime.
mechOid The array of mechanisms over which the credential is
to be acquired. Use "(Oid[]) null" for requesting a
system specific default set of mechanisms. Use an
empty array of Oid's such as "new Oid[] {}" to obtain
an empty credential which can later be built upon with
the GSSCredential.add() call.
usage The intended usage for this credential object. The
value of this parameter must be one of:
GSSCredential.ACCEPT_AND_INITIATE,
GSSCredential.ACCEPT_ONLY, GSSCredential.INITIATE_ONLY
p The preferred provider whose GSS-API implementation
should be used. "null" indicates use the default GSS-
API provider.
7.11.3. getProvider
public java.security.Provider getProvider()
Returns the provider of the IGSSCredential implementation that this
GSSCredential object is delegating all its calls to. This is useful
for applications to track which GSS implementation this object came
from. It is important to not pass an IGSSCredential implementation
(which contains provider specific internal elements) to an
IGSSContext implementation from another provider.
7.12. public class GSSContext implements IGSSContext
This concrete class is a wrapper around the interface IGSSContext.
An application can use the GSSContext class to perform all
functionality of the IGSSContext interface eliminating the need to
know the interface and instantiating it from the provider. Its
constructor performs the following in one step: obtain the provider
specific factory (IGSSFactory) object, and obtain an IGSSContext
object from the factory initialized with the parameters supplied in
the constructor. The wrapper delegates all its calls to this
provider specific IGSSContext object.
It uses the preferred GSS-API provider to instantiate the IGSSContext
implementation to delegate to. The default provider can optionally
be set by the application with the GSSManager.setDefaultProvider()
call.
The GSSContext class implements the IGSSContext interface and thus
provides for all its functionality and also passes the compiler's
type checking when used in place of IGSSContext. The methods from
IGSSContext that GSSContext implements are:
public byte[] initSecContext(byte inputBuf[],
int offset, int len) throws GSSException
public int initSecContext(InputStream inStream,
OutputStream outStream) throws GSSException
public byte[] acceptSecContext(byte inTok[], int offset,
int len) throws GSSException
public void acceptSecContext(InputStream inStream,
OutputStream outStream) throws GSSException
public boolean isEstablished()
public void dispose() throws GSSException
public int getWrapSizeLimit(int qop, boolean confReq,
int maxTokenSize) throws GSSException
public byte[] wrap(byte inBuf[], int offset, int len,
MessageProp msgProp) throws GSSException
public void wrap(InputStream inStream,
OutputStream outStream, MessageProp msgProp)
throws GSSException
public byte [] unwrap(byte[] inBuf, int offset, int len,
MessageProp msgProp) throws GSSException
public void unwrap(InputStream inStream,
OutputStream outStream, MessageProp msgProp)
throws GSSException
public byte[] getMIC(byte []inMsg, int offset, int len,
MessageProp msgProp) throws GSSException
public void getMIC(InputStream inStream,
OutputStream outStream, MessageProp msgProp)
throws GSSException
public void verifyMIC(byte []inTok, int tokOffset,
int tokLen, byte[] inMsg, int msgOffset,
int msgLen, MessageProp msgProp) throws GSSException
public void verifyMIC(InputStream tokStream,
InputStream msgStream, MessageProp msgProp)
throws GSSException
public byte [] export() throws GSSException
public void requestMutualAuth(boolean state)
throws GSSException
public void requestReplayDet(boolean state)
throws GSSException
public void requestSequenceDet(boolean state)
throws GSSException
public void requestCredDeleg(boolean state)
throws GSSException
public void requestAnonymity(boolean state)
throws GSSException
public void requestConf(boolean state) throws GSSException
public void requestInteg(boolean state) throws GSSException
public void requestLifetime(int lifetime) throws GSSException
public void setChannelBinding(ChannelBinding cb)
throws GSSException
public boolean getCredDelegState()
public boolean getMutualAuthState()
public boolean getReplayDetState()
public boolean getSequenceDetState()
public boolean getAnonymityState()
public boolean isTransferable() throws GSSException
public boolean isProtReady()
public boolean getConfState()
public boolean getIntegState()
public int getLifetime()
public GSSName getSrcName() throws GSSException
public GSSName getTargName() throws GSSException
public Oid getMech() throws GSSException
public GSSCredential getDelegCred() throws GSSException
public boolean isInitiator() throws GSSException
Similarly, it inherits the following static constant:
public static final int INDEFINITE
7.12.1. Example
The example code presented below demonstrates the usage of the
GSSContext object for the initiating peer. Different operations on
the GSSContext object are presented, including: object instantiation,
setting of desired flags, co