summaryrefslogtreecommitdiff
path: root/vendor/mellium.im/sasl/doc.go
diff options
context:
space:
mode:
authorLibravatar Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com>2021-08-12 21:03:24 +0200
committerLibravatar GitHub <noreply@github.com>2021-08-12 21:03:24 +0200
commit98263a7de64269898a2f81207e38943b5c8e8653 (patch)
tree743c90f109a6c5d27832d1dcef2388d939f0f77a /vendor/mellium.im/sasl/doc.go
parentText duplication fix (#137) (diff)
downloadgotosocial-98263a7de64269898a2f81207e38943b5c8e8653.tar.xz
Grand test fixup (#138)
* start fixing up tests * fix up tests + automate with drone * fiddle with linting * messing about with drone.yml * some more fiddling * hmmm * add cache * add vendor directory * verbose * ci updates * update some little things * update sig
Diffstat (limited to 'vendor/mellium.im/sasl/doc.go')
-rw-r--r--vendor/mellium.im/sasl/doc.go15
1 files changed, 15 insertions, 0 deletions
diff --git a/vendor/mellium.im/sasl/doc.go b/vendor/mellium.im/sasl/doc.go
new file mode 100644
index 000000000..9e7b7221e
--- /dev/null
+++ b/vendor/mellium.im/sasl/doc.go
@@ -0,0 +1,15 @@
+// Copyright 2016 The Mellium Contributors.
+// Use of this source code is governed by the BSD 2-clause license that can be
+// found in the LICENSE file.
+
+// Package sasl implements the Simple Authentication and Security Layer (SASL)
+// as defined by RFC 4422.
+//
+// Most users of this package will only need to create a Negotiator using
+// NewClient or NewServer and call its Step method repeatedly.
+// Authors implementing SASL mechanisms other than the builtin ones will want to
+// create a Mechanism struct which will likely use the other methods on the
+// Negotiator.
+//
+// Be advised: This API is still unstable and is subject to change.
+package sasl // import "mellium.im/sasl"