WS_REQUEST_SECURITY_TOKEN_PROPERTY_ID enumeration (webservices.h)

  • Article

Identifies the properties for requesting a security token from an issuer. It is used with WsRequestSecurityToken as part of the WS_REQUEST_SECURITY_TOKEN_PROPERTY* parameter.

Syntax

typedef enum {
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_APPLIES_TO = 1,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_TRUST_VERSION = 2,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_SECURE_CONVERSATION_VERSION = 3,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_TYPE = 4,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_REQUEST_ACTION = 5,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_EXISTING_TOKEN = 6,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_KEY_TYPE = 7,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_KEY_SIZE = 8,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_KEY_ENTROPY = 9,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_LOCAL_REQUEST_PARAMETERS = 10,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_SERVICE_REQUEST_PARAMETERS = 11,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_MESSAGE_PROPERTIES = 12,
  WS_REQUEST_SECURITY_TOKEN_PROPERTY_BEARER_KEY_TYPE_VERSION = 13
} WS_REQUEST_SECURITY_TOKEN_PROPERTY_ID;

Constants

 
WS_REQUEST_SECURITY_TOKEN_PROPERTY_APPLIES_TO
Value: 1
A pointer to a WS_ENDPOINT_ADDRESS structure containing the address of the service ('relying party') to whom the requested
token will be presented.
.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_TRUST_VERSION
Value: 2
A WS_TRUST_VERSION value that specifies the version of WS-Trust to use.

If this property is not specified, it defaults to WS_TRUST_VERSION_FEBRUARY_2005.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_SECURE_CONVERSATION_VERSION
Value: 3
A WS_SECURE_CONVERSATION_VERSION value that
specifies the version of WS-SecureConversation to use when WS_REQUEST_SECURITY_TOKEN_ACTION_NEW_CONTEXT
or WS_REQUEST_SECURITY_TOKEN_ACTION_RENEW_CONTEXT are specified.


If this property is not specified, it defaults to WS_SECURE_CONVERSATION_VERSION_FEBRUARY_2005.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_TYPE
Value: 4
A pointer to a WS_XML_STRING structure that specifies the type of the security token to be issued. If this property is not specified,
the corresponding element is not generated in the request security token message, and the
issuer is assumed to know the token type required.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_REQUEST_ACTION
Value: 5
A WS_REQUEST_SECURITY_TOKEN_ACTION value that specifies the action to be used with the request. The default is WS_REQUEST_SECURITY_TOKEN_ACTION_ISSUE.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_EXISTING_TOKEN
Value: 6
A pointer to a WS_SECURITY_TOKEN structure that,
if specified, instead of requesting a new token, the provided token is renewed by requesting a new token based on
the existing one. The old token becomes invalid if this operation succeeds.
Only supported with WS_REQUEST_SECURITY_TOKEN_ACTION_RENEW_CONTEXT.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_KEY_TYPE
Value: 7
A WS_SECURITY_KEY_TYPE value that specifies the type of the cryptographic key to be requested for the
issued security token. This must be set to WS_SECURITY_KEY_TYPE_NONE or WS_SECURITY_KEY_TYPE_SYMMETRIC.


The value WS_SECURITY_KEY_TYPE_NONE specifies a bearer token without
proof-of-possession keys. Such tokens will not produce a signature when used to secure a message.


If this property is not specified, the corresponding key type element is not emitted in token requests.
Not emitting the key type in token requests results in the implied default of symmetric keys for the
issued token, as defined in the WS-Trust specification.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_KEY_SIZE
Value: 8
A ULONG that specifies the size (in bits) of the cryptographic key to be requested
in the issued security token. This property may be specified only for
issued tokens with symmetric keys. If this property is not specified,
the corresponding key size element is not emitted in token requests.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_ISSUED_TOKEN_KEY_ENTROPY
Value: 9
A WS_SECURITY_KEY_ENTROPY_MODE value that specifies how entropy is contributed to the cryptographic key of the
issued token. This property may be specified only for issued tokens
with symmetric keys. If this property is not specified, the mode WS_SECURITY_KEY_ENTROPY_MODE_SERVER_ONLY is used.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_LOCAL_REQUEST_PARAMETERS
Value: 10
A pointer to a WS_XML_BUFFER that contains
the additional primary parameters to be included verbatim in request
security token messages. Each such parameter must be a top-level
element in the supplied XML buffer. If this property is not specified, such
parameters are not emitted. The buffer is serialized into the RequestSecurityToken element
when requesting a security token.


Unlike WS_REQUEST_SECURITY_TOKEN_PROPERTY_SERVICE_REQUEST_PARAMETERS, local request
parameters are defined by the client as a means to add parameters to the token request.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_SERVICE_REQUEST_PARAMETERS
Value: 11
A pointer to a WS_XML_BUFFER that contains
the service parameters to include in request security token
messages, supplied as an XML buffer. Each such parameter must be a
top-level element in the supplied XML buffer. If this is property not specified, such
parameters are not emitted.


If WS_TRUST_VERSION_FEBRUARY_2005 is specified this buffer is serialized
into the RequestSecurityToken element following the
WS_REQUEST_SECURITY_TOKEN_PROPERTY_LOCAL_REQUEST_PARAMETERS.


If WS_TRUST_VERSION_1_3 is specified this buffer is serialized into the
RequestSecurityToken/SecondaryParameters element.


Service request parameters are instructions regarding how to issue a token. They are obtained from the service,
usually by means of metadata import. In that case, this parameter may be obtained
from the out.RequestSecurityTokenTemplate field of the WS_ISSUED_TOKEN_MESSAGE_SECURITY_BINDING_CONSTRAINT.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_MESSAGE_PROPERTIES
Value: 12
The set of WS_MESSAGE_PROPERTIES to be specified
while creating the two messages with WsCreateMessage and are to
be used for the security token obtaining exchange. If this property
is not specified, the request and reply messages are created with the
default message properties.
WS_REQUEST_SECURITY_TOKEN_PROPERTY_BEARER_KEY_TYPE_VERSION
Value: 13

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Header webservices.h