File: UserNameSecurityTokenHandler.cs

package info (click to toggle)
mono 6.14.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,282,732 kB
  • sloc: cs: 11,182,461; xml: 2,850,281; ansic: 699,123; cpp: 122,919; perl: 58,604; javascript: 30,841; asm: 21,845; makefile: 19,602; sh: 10,973; python: 4,772; pascal: 925; sql: 859; sed: 16; php: 1
file content (237 lines) | stat: -rw-r--r-- 9,375 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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
//------------------------------------------------------------
// Copyright (c) Microsoft Corporation.  All rights reserved.
//------------------------------------------------------------

using System.Xml;

namespace System.IdentityModel.Tokens
{
    /// <summary>
    /// Defines a SecurityTokenHandler for Username Password Tokens. 
    /// </summary>
    public abstract class UserNameSecurityTokenHandler : SecurityTokenHandler
    {
        bool _retainPassword;

        /// <summary>
        /// Initializes an instance of <see cref="UserNameSecurityTokenHandler"/>
        /// </summary>
        protected UserNameSecurityTokenHandler()
        {
        }

        /// <summary>
        /// Controls if the password will be retained in the bootstrap token that is
        /// attached to the ClaimsIdentity in ValidateToken.  The default is false.
        /// </summary>
        public virtual bool RetainPassword
        {
            get
            {
                return _retainPassword;
            }
            set
            {
                _retainPassword = value;
            }
        }

        /// <summary>
        /// Checks the given XmlReader to verify that it is pointing to a Username
        /// token.
        /// </summary>
        /// <param name="reader">XmlReader pointing to SecurityToken.</param>
        /// <returns>True if the reader is pointing to a Username SecurityToken.</returns>
        /// <exception cref="ArgumentNullException">The given reader is null.</exception>
        public override bool CanReadToken(XmlReader reader)
        {
            if (reader == null)
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("reader");
            }

            return reader.IsStartElement(WSSecurity10Constants.Elements.UsernameToken, WSSecurity10Constants.Namespace);
        }

        /// <summary>
        /// Returns true to indicate that the handler can write UsernameSecurityToken.
        /// </summary>
        public override bool CanWriteToken
        {
            get
            {
                return true;
            }
        }

        /// <summary>
        /// Get the System.Type of the SecurityToken that this handler can handle.
        /// </summary>
        public override Type TokenType
        {
            get
            {
                return typeof(UserNameSecurityToken);
            }
        }

        /// <summary>
        /// Get the TokenTypeIdentifier of the token that this handler can work with.
        /// </summary>
        public override string[] GetTokenTypeIdentifiers()
        {
            return new string[] { SecurityTokenTypes.UserName };
        }

        /// <summary>
        /// Reads the UsernameSecurityToken from the given XmlReader.
        /// </summary>
        /// <param name="reader">XmlReader pointing to the SecurityToken.</param>
        /// <returns>An instance of <see cref="UserNameSecurityToken"/>.</returns> 
        /// <exception cref="ArgumentNullException">The parameter 'reader' is null.</exception>
        /// <exception cref="XmlException">The token cannot be read.</exception>
        /// <exception cref="NotSupportedException">The Password was not in plain text format.</exception>
        /// <exception cref="InvalidOperationException">An unknown element was found in the SecurityToken or 
        /// the username was not specified.</exception>
        public override SecurityToken ReadToken(XmlReader reader)
        {
            if (reader == null)
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("reader");
            }

            if (!CanReadToken(reader))
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(
                    new XmlException(
                        SR.GetString(
                        SR.ID4065,
                        WSSecurity10Constants.Elements.Username,
                        WSSecurity10Constants.Namespace,
                        reader.LocalName,
                        reader.NamespaceURI)));
            }

            string id = null;
            string userName = null;
            string password = null;

            reader.MoveToContent();
            id = reader.GetAttribute(WSUtilityConstants.Attributes.IdAttribute, WSUtilityConstants.NamespaceURI);

            reader.ReadStartElement(WSSecurity10Constants.Elements.UsernameToken, WSSecurity10Constants.Namespace);
            while (reader.IsStartElement())
            {
                if (reader.IsStartElement(WSSecurity10Constants.Elements.Username, WSSecurity10Constants.Namespace))
                {
                    userName = reader.ReadElementString();
                }
                else if (reader.IsStartElement(WSSecurity10Constants.Elements.Password, WSSecurity10Constants.Namespace))
                {
                    string type = reader.GetAttribute(WSSecurity10Constants.Attributes.Type, null);
                    if (!string.IsNullOrEmpty(type) && !StringComparer.Ordinal.Equals(type, WSSecurity10Constants.UPTokenPasswordTextValue))
                    {
                        throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new NotSupportedException(SR.GetString(SR.ID4059, type, WSSecurity10Constants.UPTokenPasswordTextValue)));
                    }

                    password = reader.ReadElementString();
                }
                else if (reader.IsStartElement(WSSecurity10Constants.Elements.Nonce, WSSecurity10Constants.Namespace))
                {
                    // Nonce can be safely ignored
                    reader.Skip();
                }
                else if (reader.IsStartElement(WSUtilityConstants.ElementNames.Created, WSUtilityConstants.NamespaceURI))
                {
                    // wsu:Created can be safely ignored
                    reader.Skip();
                }
                else
                {
                    throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new XmlException(SR.GetString(SR.ID4060, reader.LocalName, reader.NamespaceURI, WSSecurity10Constants.Elements.UsernameToken, WSSecurity10Constants.Namespace)));
                }
            }
            reader.ReadEndElement();

            if (string.IsNullOrEmpty(userName))
            {
                throw DiagnosticUtility.ThrowHelperInvalidOperation(SR.GetString(SR.ID4061));
            }

            return string.IsNullOrEmpty(id) ?
                new UserNameSecurityToken(userName, password) :
                new UserNameSecurityToken(userName, password, id);
        }


        /// <summary>
        /// Writes the given UsernameSecurityToken to the XmlWriter.
        /// </summary>
        /// <param name="writer">XmlWriter to write the token to.</param>
        /// <param name="token">SecurityToken to be written.</param>
        /// <exception cref="InvalidOperationException">The given token is not a UsernameSecurityToken.</exception>
        /// <exception cref="ArgumentNullException">The parameter 'writer' or 'token' is null.</exception>
        public override void WriteToken(XmlWriter writer, SecurityToken token)
        {
            if (writer == null)
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("writer");
            }

            if (token == null)
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgumentNull("token");
            }

            UserNameSecurityToken usernameSecurityToken = token as UserNameSecurityToken;

            if (usernameSecurityToken == null)
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperArgument("token", SR.GetString(SR.ID0018, typeof(UserNameSecurityToken)));
            }

            // <wsse:UsernameToken
            writer.WriteStartElement(
               WSSecurity10Constants.Elements.UsernameToken,
               WSSecurity10Constants.Namespace
               );
            if (!string.IsNullOrEmpty(token.Id))
            {
                // wsu:Id="..."
                writer.WriteAttributeString(
                       WSUtilityConstants.Attributes.IdAttribute,
                       WSUtilityConstants.NamespaceURI,
                       token.Id
                       );
            }
            // <wsse:Username>...</wsse:Username>
            writer.WriteElementString(
                WSSecurity10Constants.Elements.Username,
                WSSecurity10Constants.Namespace,
                usernameSecurityToken.UserName
                );

            // <wsse:Password>...</wsse:Password>
            if (usernameSecurityToken.Password != null)
            {
                writer.WriteStartElement(
                    WSSecurity10Constants.Elements.Password,
                    WSSecurity10Constants.Namespace
                    );

                writer.WriteAttributeString(
                    WSSecurity10Constants.Attributes.Type,
                    null,
                    WSSecurity10Constants.UPTokenPasswordTextValue
                    );

                writer.WriteString(usernameSecurityToken.Password);
                writer.WriteEndElement();
            }

            writer.WriteEndElement();

            writer.Flush();
        }
    }
}