com.ibm.security.jgss.mech.krb5

Class Krb5MechFactory

  1. java.lang.Object
  2. extended bycom.ibm.security.jgss.mech.krb5.Krb5MechFactory
All implemented interfaces:
MechanismFactory

  1. public final class Krb5MechFactory
  2. extends java.lang.Object
  3. implements MechanismFactory

Constructor Summary

Constructor and Description
Krb5MechFactory(int caller)

Method Summary

Modifier and Type Method and Description
  1. GSSCredentialSpi
getCredentialElement(GSSNameSpi name,int initLifeTime,int acceptLifeTime,int usage)
  1. GSSContextSpi
getMechanismContext(byte[] exportedContext)
  1. GSSContextSpi
getMechanismContext(GSSCredentialSpi myAcceptorCred)
  1. GSSContextSpi
getMechanismContext(GSSCredentialSpi myAcceptorCred,GSSContext myContext)
  1. GSSContextSpi
getMechanismContext(GSSNameSpi peer,GSSCredentialSpi myInitiatorCred,int lifetime)
  1. Oid
getMechanismOid()
  1. GSSNameSpi
getNameElement(byte[] nameStr,Oid nameType)
  1. GSSNameSpi
getNameElement(java.lang.String nameStr,Oid nameType)
  1. Oid[]
getNameTypes()
  1. java.security.Provider
getProvider()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Krb5MechFactory

  1. public Krb5MechFactory(int caller)

Method Detail

getMechanismOid

  1. public Oid getMechanismOid()
Description copied from interface: MechanismFactory
Returns the Oid of the mechanism that this factory supports.
Specified by:
Returns:
the Oid

getProvider

  1. public java.security.Provider getProvider( )
Description copied from interface: MechanismFactory
Returns the provider that this factory came from.
Specified by:
Returns:
the provider

getNameTypes

  1. public Oid[] getNameTypes()
Description copied from interface: MechanismFactory
Returns the GSS-API nametypes that this mechanism can support. Having this method helps the GSS-Framework decide quickly if a certain mechanism can be skipped when importing a name.
Specified by:
Returns:
an array of the Oid's corresponding to the different GSS-API nametypes supported
See Also:

getCredentialElement

  1. public GSSCredentialSpi getCredentialElement( GSSNameSpi name,
  2. int initLifeTime,
  3. int acceptLifeTime,
  4. int usage)
  5. throws GSSException
Description copied from interface: MechanismFactory
Creates a credential element for this mechanism to be included as part of a GSSCredential implementation. A GSSCredential is conceptually a container class of several credential elements from different mechanisms. A GSS-API credential can be used either for initiating GSS security contexts or for accepting them. This method also accepts parameters that indicate what usage is expected and how long the life of the credential should be. It is not necessary that the mechanism honor the request for lifetime. An application will always query an acquired GSSCredential to determine what lifetime it got back.

Not all mechanisms support the concept of one credential element that can be used for both initiating and accepting a context. In the event that an application requests usage INITIATE_AND_ACCEPT for a credential from such a mechanism, the GSS framework will need to obtain two different credential elements from the mechanism, one that will have usage INITIATE_ONLY and another that will have usage ACCEPT_ONLY. The mechanism will help the GSS-API realize this by returning a credential element with usage INITIATE_ONLY or ACCEPT_ONLY prompting it to make another call to getCredentialElement, this time with the other usage mode. The mechanism indicates the missing mode by returning a 0 lifetime for it.

Specified by:
Parameters:
name - the mechanism level name element for the entity whose credential is desired. A null value indicates that a mechanism dependent default choice is to be made.
initLifeTime - indicates the lifetime (in seconds) that is requested for this credential to be used at the context initiator's end. This value should be ignored if the usage is ACCEPT_ONLY. Predefined contants are available in the org.ietf.jgss.GSSCredential interface.
acceptLifeTime - indicates the lifetime (in seconds) that is requested for this credential to be used at the context acceptor's end. This value should be ignored if the usage is INITIATE_ONLY. Predefined contants are available in the org.ietf.jgss.GSSCredential interface.
usage - One of the values GSSCredential.INIATE_ONLY, GSSCredential.ACCEPT_ONLY, and GSSCredential.INITIATE_AND_ACCEPT.
Throws:
GSSException - if one of the error situations described in RFC 2743 with the GSS_Acquire_Cred or GSS_Add_Cred calls occurs.
See Also:

getNameElement

  1. public GSSNameSpi getNameElement( java.lang.String nameStr,
  2. Oid nameType)
  3. throws GSSException
Description copied from interface: MechanismFactory
Creates a name element for this mechanism to be included as part of a GSSName implementation. A GSSName is conceptually a container class of several name elements from different mechanisms. A GSSName can be created either with a String or with a sequence of bytes. This factory method accepts the name in a String. Such a name can generally be assumed to be printable and may be returned from the name element's toString() method.
Specified by:
Parameters:
nameStr - a string containing the characters describing this entity to the mechanism
nameType - an Oid serving as a clue as to how the mechanism should interpret the nameStr
Throws:
GSSException - if any of the errors described in RFC 2743 for the GSS_Import_Name or GSS_Canonicalize_Name calls occur.

getNameElement

  1. public GSSNameSpi getNameElement( byte[] nameStr,
  2. Oid nameType)
  3. throws GSSException
Description copied from interface: MechanismFactory
This is a variation of the factory method that accepts a String for the characters that make up the name. Usually the String characters are assumed to be printable. The bytes passed in to this method have to be converted to characters using some encoding of the mechanism's choice. It is recommended that UTF-8 be used. (Note that UTF-8 preserves the encoding for 7-bit ASCII characters.)

An exported name will generally be passed in using this method.

Specified by:
nameType - an Oid serving as a clue as to how the mechanism should interpret the nameStr
Throws:
GSSException - if any of the errors described in RFC 2743 for the GSS_Import_Name or GSS_Canonicalize_Name calls occur.

getMechanismContext

  1. public GSSContextSpi getMechanismContext( GSSNameSpi peer,
  2. GSSCredentialSpi myInitiatorCred,
  3. int lifetime)
  4. throws GSSException
Description copied from interface: MechanismFactory
Creates a security context for this mechanism so that it can be used on the context initiator's side.
Specified by:
Parameters:
peer - the name element from this mechanism that represents the peer
myInitiatorCred - a credential element for the context initiator obtained previously from this mechanism. The identity of the context initiator can be obtained from this credential. Passing a value of null here indicates that a default entity of the mechanism's choice should be assumed to be the context initiator and that default credentials should be applied.
lifetime - the requested lifetime (in seconds) for the security context. Predefined contants are available in the org.ietf.jgss.GSSContext interface.
Throws:
GSSException - if any of the errors described in RFC 2743 in the GSS_Init_Sec_Context call occur.

getMechanismContext

  1. public GSSContextSpi getMechanismContext( GSSCredentialSpi myAcceptorCred)
  2. throws GSSException
Description copied from interface: MechanismFactory
Creates a security context for this mechanism so that it can be used on the context acceptor's side.
Specified by:
Parameters:
myAcceptorCred - a credential element for the context acceptor obtained previously from this mechanism. The identity of the context acceptor cna be obtained from this credential. Passing a value of null here indicates that tha default entity of the mechanism's choice should be assumed to be the context acceptor and default credentials should be applied.
Throws:
GSSException - if any of the errors described in RFC 2743 in the GSS_Accept_Sec_Context call occur.

getMechanismContext

  1. public GSSContextSpi getMechanismContext( GSSCredentialSpi myAcceptorCred,
  2. GSSContext myContext)
  3. throws GSSException
Description copied from interface: MechanismFactory
Creates a security context for this mechanism so that it can be used on the context acceptor's side.
Specified by:
Parameters:
myAcceptorCred - a credential element for the context acceptor obtained previously from this mechanism. The identity of the context acceptor cna be obtained from this credential. Passing a value of null here indicates that tha default entity of the mechanism's choice should be assumed to be the context acceptor and default credentials should be applied.
myContext - the GSSContext object to relate to this provider-specific, mechanism-specific context object
Throws:
GSSException - if any of the errors described in RFC 2743 in the GSS_Accept_Sec_Context call occur.

getMechanismContext

  1. public GSSContextSpi getMechanismContext( byte[] exportedContext)
  2. throws GSSException
Description copied from interface: MechanismFactory
Creates a security context from a previously exported (serialized) security context. Note that this is different from Java serialization and is defined at a mechanism level to interoperate over the wire with non-Java implementations. Either the initiator or the acceptor can export and then import a security context. Implementations of mechanism contexts are not required to implement exporting and importing.
Specified by:
Parameters:
exportedContext - the bytes representing this security context
Throws:
GSSException - is any of the errors described in RFC 2743 in the GSS_Import_Sec_Context call occur.