| Don Newton | 379ae25 | 2019-04-01 12:17:06 -0400 | [diff] [blame^] | 1 | // Copyright 2018 by David A. Golden. All rights reserved. |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 4 | // not use this file except in compliance with the License. You may obtain |
| 5 | // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | |
| 7 | // Package scram provides client and server implementations of the Salted |
| 8 | // Challenge Response Authentication Mechanism (SCRAM) described in RFC-5802 |
| 9 | // and RFC-7677. |
| 10 | // |
| 11 | // Usage |
| 12 | // |
| 13 | // The scram package provides two variables, `SHA1` and `SHA256`, that are |
| 14 | // used to construct Client or Server objects. |
| 15 | // |
| 16 | // clientSHA1, err := scram.SHA1.NewClient(username, password, authID) |
| 17 | // clientSHA256, err := scram.SHA256.NewClient(username, password, authID) |
| 18 | // |
| 19 | // serverSHA1, err := scram.SHA1.NewServer(credentialLookupFcn) |
| 20 | // serverSHA256, err := scram.SHA256.NewServer(credentialLookupFcn) |
| 21 | // |
| 22 | // These objects are used to construct ClientConversation or |
| 23 | // ServerConversation objects that are used to carry out authentication. |
| 24 | package scram |