File: RequestSecurityTokenResponse.cs

package info (click to toggle)
mono 4.6.2.7%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 778,148 kB
  • ctags: 914,052
  • sloc: cs: 5,779,509; xml: 2,773,713; ansic: 432,645; sh: 14,749; makefile: 12,361; perl: 2,488; python: 1,434; cpp: 849; asm: 531; sql: 95; sed: 16; php: 1
file content (180 lines) | stat: -rw-r--r-- 5,704 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
//-----------------------------------------------------------------------
// <copyright file="RequestSecurityTokenResponse.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace System.IdentityModel.Protocols.WSTrust
{
    using System.IdentityModel.Tokens;

    /// <summary>
    /// The class defines the wst:RequestSecurityTokenResponse element which 
    /// is used to return a security token.
    /// </summary>
    public class RequestSecurityTokenResponse : WSTrustMessage
    {
        SecurityKeyIdentifierClause _requestedAttachedReference;
        RequestedProofToken _requestedProofToken;
        RequestedSecurityToken _requestedSecurityToken;
        SecurityKeyIdentifierClause _requestedUnattachedReference;
        bool _requestedTokenCancelled;
        Status _status;
        bool _isFinal = true;

        /// <summary>
        /// This constructor is usually used on the RSTR receiving end.
        /// </summary>
        public RequestSecurityTokenResponse()
            : base()
        {
        }

        /// <summary>
        /// This constructor is usually used on the RSTR sending side.
        /// </summary>
        /// <remarks>
        /// This constructor will copy some information, such as Context, KeyType, 
        /// KeySize and RequestType from the request message. Note here the RequestType
        /// is not a sub element under RSTR, need it just for token request processing.
        /// </remarks>
        public RequestSecurityTokenResponse(WSTrustMessage message)
            : base()
        {
            if (message == null)
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("message");
            }

            RequestType = message.RequestType;  // note this is NOT a sub element under RSTR
            Context = message.Context;
            KeyType = message.KeyType;

            if (message.KeySizeInBits > 0 && StringComparer.Ordinal.Equals(message.KeyType, KeyTypes.Symmetric))
            {
                KeySizeInBits = message.KeySizeInBits;
            }
        }

        /// <summary>
        /// Gets or sets the flag that determines if the RSTR is the final message
        /// and should be serialized as such.
        /// </summary>
        /// <remarks>
        /// This flag is only useful if the version of WS-Trust provides rules for serializing
        /// the final RSTR in a message flow. For instance, WS-Trust 1.3 requires the final RSTR
        /// to be enclosed within a RequestSecurityTokenResponseCollection element.
        /// </remarks>
        public bool IsFinal
        {
            get
            {
                return _isFinal;
            }
            set
            {
                _isFinal = value;
            }
        }

        /// <summary>
        /// Gets or sets the security token reference when the requested token is attached 
        /// to the message.
        /// </summary>
        /// <remarks>
        /// This optional element is specified to indicate how to reference the returned token when 
        /// that token doesn't support references using URI fragments.
        /// </remarks>
        public SecurityKeyIdentifierClause RequestedAttachedReference
        {
            get
            {
                return _requestedAttachedReference;
            }
            set
            {
                _requestedAttachedReference = value;
            }
        }

        /// <summary>
        /// Gets or sets the optional elemnet used to return the requested security token.
        /// </summary>
        public RequestedSecurityToken RequestedSecurityToken
        {
            get
            {
                return _requestedSecurityToken;
            }
            set
            {
                _requestedSecurityToken = value;
            }
        }

        /// <summary>
        /// Gets or sets the optional elemnet used to return the proof of possession token.
        /// </summary>
        public RequestedProofToken RequestedProofToken
        {
            get
            {
                return _requestedProofToken;
            }
            set
            {
                _requestedProofToken = value;
            }
        }

        /// <summary>
        /// Gets or sets the security token reference when the requested token is not attached 
        /// to the message.
        /// </summary>
        /// <remarks>
        /// This optional element is specified to indicate how to reference the returned token when 
        /// that token is not placed in the message.
        /// </remarks>
        public SecurityKeyIdentifierClause RequestedUnattachedReference
        {
            get
            {
                return _requestedUnattachedReference;
            }
            set
            {
                _requestedUnattachedReference = value;
            }
        }

        /// <summary>
        /// Gets or sets the RequestedTokenCancelled element.
        /// </summary>
        public bool RequestedTokenCancelled
        {
            get
            {
                return _requestedTokenCancelled;
            }
            set
            {
                _requestedTokenCancelled = value;
            }
        }

        /// <summary>
        /// Gets or sets the Status element in the RSTR.
        /// </summary>
        public Status Status
        {
            get
            {
                return _status;
            }
            set
            {
                _status = value;
            }
        }
    }
}