# WSSUsernameToken class documentation

### Authors

Richard Frith-Macdonald (`rfm@gnu.org`)

Version: 25485

Date: 2007-09-14 13:54:55 +0100 (Fri, 14 Sep 2007)

Copyright: (C) 2009 Free Software Foundation, Inc.

### Contents -

1. Software documentation for the WSSUsernameToken class
2. Software documentation for the NSData(SHA1) category

# Software documentation for the WSSUsernameToken class

## WSSUsernameToken : NSObject

> Declared in:
>   WSSUsernameToken.h

Supports the Web Services Security Username Token capability.
The initial implementation only supports plaintext password client use

Basic usage is simple, you create an instance of this class, initialising it with the username and password to be used to authenticate requests. Then for each request you add the token to the request header. This can be done either as a delegate of a coder or the delegate of a service. The following shows the delegate method for a service:

     - (GWSElement*) webService: (GWSService*)service willEncode: (GWSElement*)e
     {
       if (e == nil || [[e name] isEqual: @"Header"] == YES)
         {
           e = [wsstoken addToHeader: e];	// May return new object.
         }
       return e;
     }

Method summary

- -addToHeader:
- -initWithName:password:
- -initWithName:password:timeToLive:
- -tree

### addToHeader:

- (GWSElement*) addToHeader: (GWSElement*)header;
Adds a representation of the receiver to the specified SOAP header and returns the modified header. If the header is `nil`, this simply returns a representation of the receiver which can then be added to a SOAP header.

### initWithName: password:

- (id) initWithName: (NSString*)name password: (NSString*)password;
Initialise the receiver with a name and password used to authenticate with a remote server.

### initWithName: password: timeToLive:

- (id) initWithName: (NSString*)name password: (NSString*)password timeToLive: (unsigned)ttl;
This is a designated initialiser for the class.
Initialise the receiver with a name and password used to authenticate with a remote server.
If ttl is non-zero, then a hash of the token is used along with a creation date and nonce. The actual ttl value is only of use for server-side code, which will reject any message whose creation date is older than the number of seconds specified as the time to live.

### tree

- (GWSElement*) tree;
Return a tree representation of the WSS Username Token for inclusion in the header of a SOAP request.

# Software documentation for the NSData(SHA1) category

## NSData(SHA1)

> Declared in:
>   WSSUsernameToken.h

Produce an SHA1 digest of an NSData object.
Used internally by WSSUsernameToken when hash based authentication is in use.
Method summary

- -SHA1

### SHA1

- (NSData*) SHA1;
This method produces an SHA1 digest of the receiver and returns the resulting value as an autoreleased NSData object.