blob: a0e583d76c95b3bf47eb15b21e3372dcec7e463a (
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
|
using System;
using System.Collections.Generic;
using System.Text;
using DotNetOpenId;
namespace DotNetOpenId {
/// <summary>
/// An enumeration that can specify how a given <see cref="Association"/> is used.
/// </summary>
public enum AssociationRelyingPartyType {
/// <summary>
/// The <see cref="Association"/> manages a shared secret between
/// Provider and Relying Party sites that allows the RP to verify
/// the signature on a message from an OP.
/// </summary>
Smart,
/// <summary>
/// The <see cref="Association"/> manages a secret known alone by
/// a Provider that allows the Provider to verify its own signatures
/// for "dumb" (stateless) relying parties.
/// </summary>
Dumb
}
/// <summary>
/// Stores <see cref="Association"/>s for lookup by their handle, keeping
/// associations separated by a given distinguishing factor (like which server the
/// association is with).
/// </summary>
/// <typeparam name="TKey">
/// <see cref="System.Uri"/> for consumers (to distinguish associations across servers) or
/// <see cref="AssociationRelyingPartyType"/> for providers (to distingish dumb and smart client associaitons).
/// </typeparam>
public interface IAssociationStore<TKey> {
/// <summary>
/// Saves an <see cref="Association"/> for later recall.
/// </summary>
void StoreAssociation(TKey distinguishingFactor, Association assoc);
/// <summary>
/// Gets the best association (the one with the longest remaining life) for a given key.
/// Null if no unexpired <see cref="Association"/>s exist for the given key.
/// </summary>
Association GetAssociation(TKey distinguishingFactor);
/// <summary>
/// Gets the association for a given key and handle.
/// Null if no unexpired <see cref="Association"/>s exist for the given key and handle.
/// </summary>
Association GetAssociation(TKey distinguishingFactor, string handle);
/// <summary>Removes a specified handle that may exist in the store.</summary>
/// <returns>True if the association existed in this store previous to this call.</returns>
/// <remarks>
/// No exception should be thrown if the association does not exist in the store
/// before this call.
/// </remarks>
bool RemoveAssociation(TKey distinguishingFactor, string handle);
/// <summary>
/// Clears all expired associations from the store.
/// </summary>
/// <remarks>
/// If another algorithm is in place to periodically clear out expired associations,
/// this method call may be ignored.
/// This should be done frequently enough to avoid a memory leak, but sparingly enough
/// to not be a performance drain.
/// </remarks>
void ClearExpiredAssociations();
}
}
|
