From 8d2d8236a541c2088c02de9286cf20b28bc986ce Mon Sep 17 00:00:00 2001 From: David Michael Date: Tue, 21 May 2013 14:54:42 -0400 Subject: [PATCH] making the README pretty --- README => README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) rename README => README.md (86%) diff --git a/README b/README.md similarity index 86% rename from README rename to README.md index 348ffa3..a4be265 100644 --- a/README +++ b/README.md @@ -1,8 +1,9 @@ -= NTLM Implementation for Go +# NTLM Implementation for Go -== Sample Usage as NTLM Client +## Sample Usage as NTLM Client +```go import "ntlm" import "ntlm/messages" @@ -19,9 +20,11 @@ session.ProcessChallengeMessage(challenge) authenticate := session.GenerateAuthenticateMessage() +``` -== Sample Usage as NTLM Server +## Sample Usage as NTLM Server +```go session = ntlm.NewServerSession(ntlm.Version1, ntlm.ConnectionlessMode) session.SetUserInfo("someuser","somepassword","somedomain") @@ -33,16 +36,18 @@ challenge := session.GenerateChallengeMessage() auth, err := messages.ParseAuthentiateMessage(authenticateBytes) session.ProcessAuthenticateMessage(auth) +``` -== Generating a message MAC +## Generating a message MAC Once a session is created you can generate the Mac for a message using: +```go message := "this is some message to sign" sequenceNumber := 100 signature, err := session.Mac([]byte(message), sequenceNumber) +``` - -== License +## License Copyright Thomson Reuters Global Resources 2013 Apache License