blob: c263277a517a035bec394fadb7fe699d9e33bd21 (
plain)
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
|
//-----------------------------------------------------------------------
// <copyright file="IAuthorizationServer.cs" company="Andrew Arnott">
// Copyright (c) Andrew Arnott. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.OAuthWrap {
using System;
using System.Collections.Generic;
using System.Diagnostics.Contracts;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using DotNetOpenAuth.Messaging.Bindings;
using DotNetOpenAuth.OAuth.ChannelElements;
using DotNetOpenAuth.OAuthWrap.ChannelElements;
/// <summary>
/// Provides host-specific authorization server services needed by this library.
/// </summary>
[ContractClass(typeof(IAuthorizationServerContract))]
public interface IAuthorizationServer {
/// <summary>
/// Gets the secret used to symmetrically encrypt and sign verification codes and refresh tokens.
/// </summary>
/// <remarks>
/// This secret should be kept strictly confidential in the authorization server(s)
/// and NOT shared with the resource server. Anyone with this secret can mint
/// tokens to essentially grant themselves access to anything they want.
/// </remarks>
byte[] Secret { get; }
/// <summary>
/// Gets the asymmetric private key to use for signing access tokens.
/// </summary>
/// <remarks>
/// The public key in the private/public key pair will be used by the resource
/// servers to validate that the access token is minted by a trusted authorization server.
/// </remarks>
RSAParameters AccessTokenSigningPrivateKey { get; }
/// <summary>
/// Gets the verification code nonce store to use to ensure that verification codes can only be used once.
/// </summary>
/// <value>The verification code nonce store.</value>
INonceStore VerificationCodeNonceStore { get; }
/// <summary>
/// Gets the client with a given identifier.
/// </summary>
/// <param name="clientIdentifier">The client identifier.</param>
/// <returns>The client registration. Never null.</returns>
/// <exception cref="ArgumentException">Thrown when no client with the given identifier is registered with this authorization server.</exception>
IConsumerDescription GetClient(string clientIdentifier);
/// <summary>
/// Determines whether a described authorization is (still) valid.
/// </summary>
/// <param name="authorization">The authorization.</param>
/// <returns>
/// <c>true</c> if the original authorization is still valid; otherwise, <c>false</c>.
/// </returns>
/// <remarks>
/// <para>When establishing that an authorization is still valid,
/// it's very important to only match on recorded authorizations that
/// meet these criteria:</para>
/// 1) The client identifier matches.
/// 2) The user account matches.
/// 3) The scope on the recorded authorization must include all scopes in the given authorization.
/// 4) The date the recorded authorization was issued must be <em>no later</em> that the date the given authorization was issued.
/// <para>One possible scenario is where the user authorized a client, later revoked authorization,
/// and even later reinstated authorization. This subsequent recorded authorization
/// would not satisfy requirement #4 in the above list. This is important because the revocation
/// the user went through should invalidate all previously issued tokens as a matter of
/// security in the event the user was revoking access in order to sever authorization on a stolen
/// account or piece of hardware in which the tokens were stored. </para>
/// </remarks>
bool IsAuthorizationValid(IAuthorizationDescription authorization);
}
/// <summary>
/// Code Contract for the <see cref="IAuthorizationServer"/> interface.
/// </summary>
[ContractClassFor(typeof(IAuthorizationServer))]
internal abstract class IAuthorizationServerContract : IAuthorizationServer {
/// <summary>
/// Prevents a default instance of the <see cref="IAuthorizationServerContract"/> class from being created.
/// </summary>
private IAuthorizationServerContract() {
}
/// <summary>
/// Gets the secret used to symmetrically encrypt and sign verification codes and refresh tokens.
/// </summary>
/// <value></value>
/// <remarks>
/// This secret should be kept strictly confidential in the authorization server(s)
/// and NOT shared with the resource server. Anyone with this secret can mint
/// tokens to essentially grant themselves access to anything they want.
/// </remarks>
byte[] IAuthorizationServer.Secret {
get {
Contract.Ensures(Contract.Result<byte[]>() != null);
throw new NotImplementedException();
}
}
/// <summary>
/// Gets the asymmetric private key to use for signing access tokens.
/// </summary>
/// <value></value>
/// <remarks>
/// The public key in the private/public key pair will be used by the resource
/// servers to validate that the access token is minted by a trusted authorization server.
/// </remarks>
RSAParameters IAuthorizationServer.AccessTokenSigningPrivateKey {
get { throw new NotImplementedException(); }
}
/// <summary>
/// Gets the verification code nonce store to use to ensure that verification codes can only be used once.
/// </summary>
/// <value>The verification code nonce store.</value>
INonceStore IAuthorizationServer.VerificationCodeNonceStore {
get {
Contract.Ensures(Contract.Result<INonceStore>() != null);
throw new NotImplementedException();
}
}
/// <summary>
/// Gets the client with a given identifier.
/// </summary>
/// <param name="clientIdentifier">The client identifier.</param>
/// <returns>The client registration. Never null.</returns>
/// <exception cref="ArgumentException">Thrown when no client with the given identifier is registered with this authorization server.</exception>
IConsumerDescription IAuthorizationServer.GetClient(string clientIdentifier) {
Contract.Requires<ArgumentException>(!String.IsNullOrEmpty(clientIdentifier));
Contract.Ensures(Contract.Result<IConsumerDescription>() != null);
throw new NotImplementedException();
}
/// <summary>
/// Determines whether a described authorization is (still) valid.
/// </summary>
/// <param name="authorization">The authorization.</param>
/// <returns>
/// <c>true</c> if the original authorization is still valid; otherwise, <c>false</c>.
/// </returns>
/// <remarks>
/// <para>When establishing that an authorization is still valid,
/// it's very important to only match on recorded authorizations that
/// meet these criteria:</para>
/// 1) The client identifier matches.
/// 2) The user account matches.
/// 3) The scope on the recorded authorization must include all scopes in the given authorization.
/// 4) The date the recorded authorization was issued must be <em>no later</em> that the date the given authorization was issued.
/// <para>One possible scenario is where the user authorized a client, later revoked authorization,
/// and even later reinstated authorization. This subsequent recorded authorization
/// would not satisfy requirement #4 in the above list. This is important because the revocation
/// the user went through should invalidate all previously issued tokens as a matter of
/// security in the event the user was revoking access in order to sever authorization on a stolen
/// account or piece of hardware in which the tokens were stored. </para>
/// </remarks>
bool IAuthorizationServer.IsAuthorizationValid(IAuthorizationDescription authorization) {
Contract.Requires<ArgumentNullException>(authorization != null, "authorization");
throw new NotImplementedException();
}
}
}
|
