Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
Added precisions on Request Authenticators.
  • Loading branch information
MathieuTurcotte committed Feb 9, 2012
1 parent d0f9277 commit afd95d1
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Expand Up @@ -35,7 +35,7 @@ informations, one would do:

Behind the scene, the authenticator will add an Authorization header to your request.

### RequestAuthenticators
### Request Authenticators

`RequestAuthenticator` implementing the `HMAC-SHA1`, `RSA-SHA1` and `PLAINTEXT`
signature methods are provided. `RequestAuthenticator` instances are created
Expand All @@ -45,6 +45,15 @@ through the `RequestAuthenticatorFactory` which expose three factory methods.
RequestAuthenticator GetHmacSha1Authenticator(ClientCredentials credentials, AccessToken token);
RequestAuthenticator GetRsaSha1Authenticator(ClientCredentials credentials, AccessToken token, RSAParameters key);

`RequestAuthenticator` is simply an interface providing a method for signing
[`WebRequest`](http://msdn.microsoft.com/en-us/library/system.net.webrequest.aspx)
instances.

public interface RequestAuthenticator
{
void SignRequest(WebRequest request);
}

Authenticators are thread-safe.

Limitations
Expand Down

0 comments on commit afd95d1

Please sign in to comment.