blob: e0f84b95d7e24fe133fe1a88948d07f7266d6d3d (
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
|
//-----------------------------------------------------------------------
// <copyright file="IProviderAssociationStore.cs" company="Outercurve Foundation">
// Copyright (c) Outercurve Foundation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.OpenId.Provider {
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using DotNetOpenAuth.Messaging;
using Validation;
/// <summary>
/// Provides association serialization and deserialization.
/// </summary>
/// <remarks>
/// Implementations may choose to store the association details in memory or a database table and simply return a
/// short, randomly generated string that is the key to that data. Alternatively, an implementation may
/// sign and encrypt the association details and then encode the results as a base64 string and return that value
/// as the association handle, thereby avoiding any association persistence at the OpenID Provider.
/// When taking the latter approach however, it is of course imperative that the association be encrypted
/// to avoid disclosing the secret to anyone who sees the association handle, which itself isn't considered to
/// be confidential.
/// </remarks>
internal interface IProviderAssociationStore {
/// <summary>
/// Stores an association and returns a handle for it.
/// </summary>
/// <param name="secret">The association secret.</param>
/// <param name="expiresUtc">The UTC time that the association should expire.</param>
/// <param name="privateAssociation">A value indicating whether this is a private association.</param>
/// <returns>
/// The association handle that represents this association.
/// </returns>
string Serialize(byte[] secret, DateTime expiresUtc, bool privateAssociation);
/// <summary>
/// Retrieves an association given an association handle.
/// </summary>
/// <param name="containingMessage">The OpenID message that referenced this association handle.</param>
/// <param name="privateAssociation">A value indicating whether a private association is expected.</param>
/// <param name="handle">The association handle.</param>
/// <returns>
/// An association instance, or <c>null</c> if the association has expired or the signature is incorrect (which may be because the OP's symmetric key has changed).
/// </returns>
/// <exception cref="ProtocolException">Thrown if the association is not of the expected type.</exception>
Association Deserialize(IProtocolMessage containingMessage, bool privateAssociation, string handle);
}
}
|
