Specifies a UserIdentityToken that a Server will accept. More...

#include <usertokenpolicy.h>

Data Fields
struct ua_string	policy_id
	An identifier for the UserTokenPolicy assigned by the Server. More...

enum ua_usertokentype	token_type
	The type of user identity token required. More...

struct ua_string	issued_token_type
	A URI for the type of token. More...

struct ua_string	issuer_endpoint_url
	An optional URL for the token issuing service. More...

struct ua_string	security_policy_uri
	The security policy to use when encrypting or signing the UserIdentityToken when it is passed to the Server in the ActivateSession request. More...

Related Functions
void	ua_usertokenpolicy_init (struct ua_usertokenpolicy *t)
	Initialize an ua_usertokenpolicy struct with a valid value. More...

void	ua_usertokenpolicy_clear (struct ua_usertokenpolicy *t)
	Clear all resources alloctated in an ua_usertokenpolicy struct. More...

int	ua_usertokenpolicy_compare (const struct ua_usertokenpolicy a, const struct ua_usertokenpolicy b)
	Compare two ua_usertokenpolicy structs. More...

int	ua_usertokenpolicy_copy (struct ua_usertokenpolicy dst, const struct ua_usertokenpolicy src)
	Create a copy of a ua_usertokenpolicy struct. More...

Detailed Description

Specifies a UserIdentityToken that a Server will accept.

Friends And Related Function Documentation

void ua_usertokenpolicy_clear ( struct ua_usertokenpolicy * t )

Frees allocated memory like arrays and resets numeric values. The ua_usertokenpolicy struct itself is not freed and must be freed by the caller if required. This function always succeeds for a valid ua_usertokenpolicy struct, that was validly decoded, initilized by ua_usertokenpolicy_init or created with ua_usertokenpolicy_copy.

int ua_usertokenpolicy_compare	(	const struct ua_usertokenpolicy *	a,
		const struct ua_usertokenpolicy *	b
	)

Compares the content of the ua_usertokenpolicy struct a to the content of the ua_usertokenpolicy struct b. If a is smaller than b, an integer less than zero is returned, if a is bigger than b, an integer greater than zero is returned. If both structs are equal zero is returned.

This function creates a total order on ua_usertokenpolicy structs, so it is well suited to not only determine equality, but also sort multiple instances of this struct.

int ua_usertokenpolicy_copy	(	struct ua_usertokenpolicy *	dst,
		const struct ua_usertokenpolicy *	src
	)

Copy all fields from struct ua_usertokenpolicy src to dst. Creates a deep copy so all content is recusively copied and both src and dst can be used and must be freed separately.

dst is not cleared before the copy operation, so it must not have any allocated data. It may or may not be initilized by the caller before copy.

Returns: Zero on success or ua_statuscode on failure.

void ua_usertokenpolicy_init ( struct ua_usertokenpolicy * t )

After initialization the fields of the struct are set to valid and consistent values and can safley be accessed. An initialized ua_usertokenpolicy struct can also be passed to ua_usertokenpolicy_compare, ua_usertokenpolicy_copy and ua_usertokenpolicy_clear. This function will always succeed as long as an ua_usertokenpolicy struct is passed to it.

Field Documentation

issued_token_type

A URI for the type of token.

Part 6 of the OPC UA Specification defines URIs for common issued token types. Vendors may specify their own token.

This field may only be specified if TokenType is IssuedToken.

issuer_endpoint_url

An optional URL for the token issuing service.

The meaning of this value depends on the IssuedTokenType.

policy_id

An identifier for the UserTokenPolicy assigned by the Server.

The Client specifies this value when it constructs a UserIdentityToken that conforms to the policy.

This value is only unique within the context of a single Server.

security_policy_uri

The security policy to use when encrypting or signing the UserIdentityToken when it is passed to the Server in the ActivateSession request.

The security policy for the SecureChannel is used if this value is omitted.

token_type

The type of user identity token required.

A tokenType of ANONYMOUS indicates that the Server does not require any user identification. In this case the Client application instance certificate is used as the user identification.

The documentation for this struct was generated from the following files:

C:/work/embeddedstack/src/uabase/structure/usertokenpolicy.h
C:/work/embeddedstack/src/uabase/structure/usertokenpolicy.c

Data Fields

Related Functions

Detailed Description

Friends And Related Function Documentation

Field Documentation