com.ibm.security.jgss.spi

Interface GSSContextSpi

All known implementing classes:
SPNEGOContext

  1. public interface GSSContextSpi
This interface is implemented by a mechanism specific instance of a GSS security context. A GSSContextSpi object can be thought of having 3 states: -before initialization -during initialization with its peer -after it is established

The context options can only be requested in state 1. In state 3, the per message operations are available to the callers. The get methods for the context options will return the requested options while in state 1 and 2, and the established values in state 3. Some mechanisms may allow the access to the per-message operations and the context flags before the context is fully established. The isProtReady method is used to indicate that these services are available.

Context establishment tokens are defined in a mechanism independent format in section 3.1 of RFC 2743. The GSS-Framework will add and remove the mechanism independent header portion of this token format depending on whether a token is received or is being sent. The mechanism should only generate or expect to read the inner-context token portion..

On the other hands, tokens used for per-message calls are generated entirely by the mechanism. It is possible that the mechanism chooses to encase inner-level per-message tokens in a header similar to that used for initial tokens, however, this is upto the mechanism to do. The token to/from the per-message calls are opaque to the GSS-Framework.

An attempt has been made to allow for reading the peer's tokens from an InputStream and writing tokens for the peer to an OutputStream. This allows applications to pass in streams that are obtained from their network connections and thus minimize the buffer copies that will happen. This is especially important for tokens generated by wrap() which are proportional in size to the length of the application data being wrapped, and are probably also the most frequently used type of tokens.

It is anticipated that most applications will want to use wrap() in a fashion where they obtain the application bytes to wrap from a byte[] but want to output the wrap token straight to an OutputStream. Similarly, they will want to use unwrap() where they read the token directly form an InputStream but output it to some byte[] for the application to process. Unfortunately the high level GSS bindings do not contain overloaded forms of wrap() and unwrap() that do just this, however we have accomodated those cases here with the expectation that this will be rolled into the high level bindings sooner or later.

Version:
1.4, 12/14/01
Author:
Mayank Upadhyay

Method Summary

Modifier and Type Method and Description
  1. byte[]
acceptSecContext(java.io.InputStream is,int mechTokenSize)
Acceptor's context establishment call.
  1. void
dispose()
Releases context resources and terminates the context between 2 peer.
  1. byte[]
export()
Produces a token representing this context.
  1. boolean
getAnonymityState()
  1. boolean
getConfState()
  1. boolean
getCredDelegState()
  1. GSSCredentialSpi
getDelegCred()
  1. boolean
getIntegState()
  1. int
getLifetime()
  1. Oid
getMech()
  1. byte[]
getMIC(byte[] inMsg,int offset,int len,MessageProp msgProp)
  1. void
getMIC(java.io.InputStream is,java.io.OutputStream os,MessageProp msgProp)
Applies per-message integrity services.
  1. boolean
getMutualAuthState()
  1. java.security.Provider
getProvider()
  1. boolean
getReplayDetState()
  1. boolean
getSequenceDetState()
  1. GSSNameSpi
getSrcName()
  1. GSSNameSpi
getTargName()
  1. int
getWrapSizeLimit(int qop,boolean confReq,int maxTokSize)
Queries the context for largest data size to accomodate the specified protection and for the token to remain less then maxTokSize.
  1. byte[]
initSecContext(java.io.InputStream is,int mechTokenSize)
Initiator context establishment call.
  1. boolean
isEstablished()
  1. boolean
isProtReady()
  1. boolean
isTransferable()
  1. void
requestAnonymity(boolean state)
  1. void
requestConf(boolean state)
  1. void
requestCredDeleg(boolean state)
  1. void
requestInteg(boolean state)
  1. void
requestLifetime(int lifetime)
  1. void
requestMutualAuth(boolean state)
  1. void
requestReplayDet(boolean state)
  1. void
requestSequenceDet(boolean state)
  1. void
setChannelBinding(ChannelBinding cb)
  1. void
setNegMechs(Oid[] mechTypes,GSSCredential credential)
For SPNEGO mechanism.
  1. int
unwrap(byte[] inBuf,int inOffset,int len,byte[] outBuf,int outOffset,MessageProp msgProp)
For apps that care about buffer copies but either cannot use streams or want to avoid them for whatever reason.
  1. byte[]
unwrap(byte[] inBuf,int offset,int len,MessageProp msgProp)
For apps that want simplicity and dont care about buffer copies.
  1. int
unwrap(java.io.InputStream is,byte[] outBuf,int outOffset,MessageProp msgProp)
For apps that care about buffer copies and want to read straight from the network, but also want the output in a specific application provided buffer, say to reduce buffer allocation or subsequent copy.
  1. void
unwrap(java.io.InputStream is,java.io.OutputStream os,MessageProp msgProp)
Retrieves the message token previously encapsulated in the wrap call.
  1. void
verifyMIC(byte[] inTok,int tokOffset,int tokLen,byte[] inMsg,int msgOffset,int msgLen,MessageProp msgProp)
  1. void
verifyMIC(java.io.InputStream is,java.io.InputStream msgStr,MessageProp mProp)
Checks the integrity of the supplied tokens.
  1. int
wrap(byte[] inBuf,int inOffset,int len,byte[] outBuf,int outOffset,MessageProp msgProp)
For apps that care about buffer copies but either cannot use streams or want to avoid them for whatever reason.
  1. byte[]
wrap(byte[] inBuf,int offset,int len,MessageProp msgProp)
For apps that want simplicity and don't care about buffer copies.
  1. void
wrap(byte[] inBuf,int offset,int len,java.io.OutputStream os,MessageProp msgProp)
For apps that want to read from a specific application provided buffer but want to write directly to the network stream.
  1. void
wrap(java.io.InputStream is,java.io.OutputStream os,MessageProp msgProp)
Provides per-message token encapsulation.

Method Detail

getProvider

  1. java.security.Provider getProvider( )

requestLifetime

  1. void requestLifetime(int lifetime)
  2. throws GSSException
Throws:

requestMutualAuth

  1. void requestMutualAuth(boolean state)
  2. throws GSSException
Throws:

requestReplayDet

  1. void requestReplayDet(boolean state)
  2. throws GSSException
Throws:

requestSequenceDet

  1. void requestSequenceDet(boolean state)
  2. throws GSSException
Throws:

requestCredDeleg

  1. void requestCredDeleg(boolean state)
  2. throws GSSException
Throws:

requestAnonymity

  1. void requestAnonymity(boolean state)
  2. throws GSSException
Throws:

requestConf

  1. void requestConf(boolean state)
  2. throws GSSException
Throws:

requestInteg

  1. void requestInteg(boolean state)
  2. throws GSSException
Throws:

setChannelBinding

  1. void setChannelBinding(ChannelBinding cb)
  2. throws GSSException
Throws:

getCredDelegState

  1. boolean getCredDelegState()

getMutualAuthState

  1. boolean getMutualAuthState()

getReplayDetState

  1. boolean getReplayDetState()

getSequenceDetState

  1. boolean getSequenceDetState()

getAnonymityState

  1. boolean getAnonymityState()

isTransferable

  1. boolean isTransferable()
  2. throws GSSException
Throws:

isProtReady

  1. boolean isProtReady()

getConfState

  1. boolean getConfState()

getIntegState

  1. boolean getIntegState()

getLifetime

  1. int getLifetime()

isEstablished

  1. boolean isEstablished()

getSrcName

  1. GSSNameSpi getSrcName()
  2. throws GSSException
Throws:

getTargName

  1. GSSNameSpi getTargName()
  2. throws GSSException
Throws:

getMech

  1. Oid getMech()
  2. throws GSSException
Throws:

getDelegCred

  1. GSSCredentialSpi getDelegCred()
  2. throws GSSException
Throws:

initSecContext

  1. byte[] initSecContext(java.io.InputStream is,
  2. int mechTokenSize)
  3. throws GSSException
Initiator context establishment call. This method may be required to be called several times. A CONTINUE_NEEDED return call indicates that more calls are needed after the next token is received from the peer.

This method is called by the GSS-Framework when the application calls the initSecContext method on the GSSContext implementation that it has a reference to.

All overloaded forms of GSSContext.initSecContext() can be handled with this mechanism level initSecContext. Since the output token from this method is a fixed size, not exeedingly large, and a one time deal, an overloaded form that takes an OutputStream has not been defined. The GSS-Framwork can write the returned byte[] to any application provided OutputStream. Similarly, any application input int he form of byte arrays will be wrapped in an input stream by the GSS-Framework and then passed here.

The GSS-Framework will strip off the leading mechanism independent GSS-API header. In other words, only the mechanism specific inner-context token of RFC 2743 section 3.1 will be available on the InputStream.

Parameters:
is - contains the inner context token portion of the GSS token received from the peer. On the first call to initSecContext, there will be no token hence it will be ignored.
mechTokenSize - the size of the inner context token as read by the GSS-Framework from the mechanism independent GSS-API level header.
Returns:
any inner-context token required to be sent to the peer as part of a GSS token. The mechanism should not add the mechanism independent part of the token. The GSS-Framework will add that on the way out.
Throws:
GSSException - may be thrown

acceptSecContext

  1. byte[] acceptSecContext(java.io.InputStream is,
  2. int mechTokenSize)
  3. throws GSSException
Acceptor's context establishment call. This method may be required to be called several times. A CONTINUE_NEEDED return call indicates that more calls are needed after the next token is received from the peer.

This method is called by the GSS-Framework when the application calls the acceptSecContext method on the GSSContext implementation that it has a reference to.

All overloaded forms of GSSContext.acceptSecContext() can be handled with this mechanism level acceptSecContext. Since the output token from this method is a fixed size, not exeedingly large, and a one time deal, an overloaded form that takes an OutputStream has not been defined. The GSS-Framwork can write the returned byte[] to any application provided OutputStream. Similarly, any application input int he form of byte arrays will be wrapped in an input stream by the GSS-Framework and then passed here.

The GSS-Framework will strip off the leading mechanism independent GSS-API header. In other words, only the mechanism specific inner-context token of RFC 2743 section 3.1 will be available on the InputStream.

Parameters:
is - contains the inner context token portion of the GSS token received from the peer.
mechTokenSize - the size of the inner context token as read by the GSS-Framework from the mechanism independent GSS-API level header.
Returns:
any inner-context token required to be sent to the peer as part of a GSS token. The mechanism should not add the mechanism independent part of the token. The GSS-Framework will add that on the way out.
Throws:
GSSException - may be thrown

getWrapSizeLimit

  1. int getWrapSizeLimit(int qop,
  2. boolean confReq,
  3. int maxTokSize)
  4. throws GSSException
Queries the context for largest data size to accomodate the specified protection and for the token to remain less then maxTokSize.
Parameters:
qop - the quality of protection that the context will be asked to provide.
confReq - a flag indicating whether confidentiality will be requested or not
Returns:
the maximum size for the input message that can be provided to the wrap() method in order to guarantee that these requirements are met.
Throws:
GSSException - may be thrown

wrap

  1. void wrap(java.io.InputStream is,
  2. java.io.OutputStream os,
  3. MessageProp msgProp)
  4. throws GSSException
Provides per-message token encapsulation.
Parameters:
is - the user-provided message to be protected
os - the token to be sent to the peer. It includes the message from is with the requested protection.
Throws:
GSSException - may be thrown
See Also:
MessageInfo, unwrap

wrap

  1. byte[] wrap(byte[] inBuf,
  2. int offset,
  3. int len,
  4. MessageProp msgProp)
  5. throws GSSException
For apps that want simplicity and don't care about buffer copies.
Throws:

wrap

  1. int wrap(byte[] inBuf,
  2. int inOffset,
  3. int len,
  4. byte[] outBuf,
  5. int outOffset,
  6. MessageProp msgProp)
  7. throws GSSException
For apps that care about buffer copies but either cannot use streams or want to avoid them for whatever reason. (Say, they are using block ciphers.)
Throws:

wrap

  1. void wrap(byte[] inBuf,
  2. int offset,
  3. int len,
  4. java.io.OutputStream os,
  5. MessageProp msgProp)
  6. throws GSSException
For apps that want to read from a specific application provided buffer but want to write directly to the network stream.
Throws:

unwrap

  1. void unwrap(java.io.InputStream is,
  2. java.io.OutputStream os,
  3. MessageProp msgProp)
  4. throws GSSException
Retrieves the message token previously encapsulated in the wrap call.
Parameters:
is - the token from the peer
os - unprotected message data
msgProp - will contain the applied qop and confidentiality of the input token and any informatory status values
Throws:
GSSException - may be thrown
See Also:
MessageInfo, wrap

unwrap

  1. byte[] unwrap(byte[] inBuf,
  2. int offset,
  3. int len,
  4. MessageProp msgProp)
  5. throws GSSException
For apps that want simplicity and dont care about buffer copies.
Throws:

unwrap

  1. int unwrap(byte[] inBuf,
  2. int inOffset,
  3. int len,
  4. byte[] outBuf,
  5. int outOffset,
  6. MessageProp msgProp)
  7. throws GSSException
For apps that care about buffer copies but either cannot use streams or want to avoid them for whatever reason. (Say, they are using block ciphers.)
Throws:

unwrap

  1. int unwrap(java.io.InputStream is,
  2. byte[] outBuf,
  3. int outOffset,
  4. MessageProp msgProp)
  5. throws GSSException
For apps that care about buffer copies and want to read straight from the network, but also want the output in a specific application provided buffer, say to reduce buffer allocation or subsequent copy.
Throws:

getMIC

  1. void getMIC(java.io.InputStream is,
  2. java.io.OutputStream os,
  3. MessageProp msgProp)
  4. throws GSSException
Applies per-message integrity services.
Parameters:
is - the user-provided message
os - the token to be sent to the peer along with the message token. The message token is not encapsulated.
msgProp - on input the desired QOP and output the applied QOP
Throws:

getMIC

  1. byte[] getMIC(byte[] inMsg,
  2. int offset,
  3. int len,
  4. MessageProp msgProp)
  5. throws GSSException
Throws:

verifyMIC

  1. void verifyMIC(java.io.InputStream is,
  2. java.io.InputStream msgStr,
  3. MessageProp mProp)
  4. throws GSSException
Checks the integrity of the supplied tokens. This token was previously generated by getMIC.
Parameters:
is - token generated by getMIC
msgStr - the message to check integrity for
Throws:
GSSException - may be thrown

verifyMIC

  1. void verifyMIC(byte[] inTok,
  2. int tokOffset,
  3. int tokLen,
  4. byte[] inMsg,
  5. int msgOffset,
  6. int msgLen,
  7. MessageProp msgProp)
  8. throws GSSException
Throws:

export

  1. byte[] export()
  2. throws GSSException
Produces a token representing this context. After this call the context will no longer be usable until an import is performed on the returned token.
Returns:
exported context token
Throws:
GSSException - may be thrown

dispose

  1. void dispose()
  2. throws GSSException
Releases context resources and terminates the context between 2 peer.
Throws:
GSSException - may be thrown

setNegMechs

  1. void setNegMechs(Oid[] mechTypes,
  2. GSSCredential credential)
  3. throws GSSException
For SPNEGO mechanism. Other mechanisms can implement this to throw a GSSException.UNAVAILABLE exception.
Throws: