mirror of
https://github.com/kataras/iris.git
synced 2026-01-09 13:05:56 +00:00
replace ioutil with io package and other minor improvements
This commit is contained in:
@@ -52,8 +52,9 @@ type ErrorHandler func(ctx *context.Context, err error)
|
||||
// The only required value is the Allow field.
|
||||
//
|
||||
// Usage:
|
||||
// opts := Options { ... }
|
||||
// auth := New(opts)
|
||||
//
|
||||
// opts := Options { ... }
|
||||
// auth := New(opts)
|
||||
type Options struct {
|
||||
// Realm directive, read http://tools.ietf.org/html/rfc2617#section-1.2 for details.
|
||||
// E.g. "Authorization Required".
|
||||
@@ -171,17 +172,18 @@ type BasicAuth struct {
|
||||
// The result should be used to wrap an existing handler or the HTTP application's root router.
|
||||
//
|
||||
// Example Code:
|
||||
// opts := basicauth.Options{
|
||||
// Realm: basicauth.DefaultRealm,
|
||||
// ErrorHandler: basicauth.DefaultErrorHandler,
|
||||
// MaxAge: 2 * time.Hour,
|
||||
// GC: basicauth.GC{
|
||||
// Every: 3 * time.Hour,
|
||||
// },
|
||||
// Allow: basicauth.AllowUsers(users),
|
||||
// }
|
||||
// auth := basicauth.New(opts)
|
||||
// app.Use(auth)
|
||||
//
|
||||
// opts := basicauth.Options{
|
||||
// Realm: basicauth.DefaultRealm,
|
||||
// ErrorHandler: basicauth.DefaultErrorHandler,
|
||||
// MaxAge: 2 * time.Hour,
|
||||
// GC: basicauth.GC{
|
||||
// Every: 3 * time.Hour,
|
||||
// },
|
||||
// Allow: basicauth.AllowUsers(users),
|
||||
// }
|
||||
// auth := basicauth.New(opts)
|
||||
// app.Use(auth)
|
||||
//
|
||||
// Access the user in the route handler with: ctx.User().GetRaw().(*myCustomType).
|
||||
//
|
||||
@@ -238,16 +240,18 @@ func New(opts Options) context.Handler {
|
||||
// are required as they are compared against the user input
|
||||
// when access to protected resource is requested.
|
||||
// A user list can defined with one of the following values:
|
||||
// map[string]string form of: {username:password, ...}
|
||||
// map[string]interface{} form of: {"username": {"password": "...", "other_field": ...}, ...}
|
||||
// []T which T completes the User interface, where T is a struct value
|
||||
// []T which T contains at least Username and Password fields.
|
||||
//
|
||||
// map[string]string form of: {username:password, ...}
|
||||
// map[string]interface{} form of: {"username": {"password": "...", "other_field": ...}, ...}
|
||||
// []T which T completes the User interface, where T is a struct value
|
||||
// []T which T contains at least Username and Password fields.
|
||||
//
|
||||
// Usage:
|
||||
// auth := Default(map[string]string{
|
||||
// "admin": "admin",
|
||||
// "john": "p@ss",
|
||||
// })
|
||||
//
|
||||
// auth := Default(map[string]string{
|
||||
// "admin": "admin",
|
||||
// "john": "p@ss",
|
||||
// })
|
||||
func Default(users interface{}, userOpts ...UserAuthOption) context.Handler {
|
||||
opts := Options{
|
||||
Realm: DefaultRealm,
|
||||
@@ -260,7 +264,8 @@ func Default(users interface{}, userOpts ...UserAuthOption) context.Handler {
|
||||
// a filename to load the users from.
|
||||
//
|
||||
// Usage:
|
||||
// auth := Load("users.yml")
|
||||
//
|
||||
// auth := Load("users.yml")
|
||||
func Load(jsonOrYamlFilename string, userOpts ...UserAuthOption) context.Handler {
|
||||
opts := Options{
|
||||
Realm: DefaultRealm,
|
||||
|
||||
@@ -3,7 +3,7 @@ package basicauth
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"reflect"
|
||||
"strings"
|
||||
|
||||
@@ -16,8 +16,8 @@ import (
|
||||
// ReadFile can be used to customize the way the
|
||||
// AllowUsersFile function is loading the filename from.
|
||||
// Example of usage: embedded users.yml file.
|
||||
// Defaults to the `ioutil.ReadFile` which reads the file from the physical disk.
|
||||
var ReadFile = ioutil.ReadFile
|
||||
// Defaults to the `os.ReadFile` which reads the file from the physical disk.
|
||||
var ReadFile = os.ReadFile
|
||||
|
||||
// User is a partial part of the iris.User interface.
|
||||
// It's used to declare a static slice of registered User for authentication.
|
||||
@@ -48,10 +48,11 @@ type UserAuthOption func(*UserAuthOptions)
|
||||
// See https://www.usenix.org/legacy/event/usenix99/provos/provos.pdf.
|
||||
//
|
||||
// Usage:
|
||||
// Default(..., BCRYPT) OR
|
||||
// Load(..., BCRYPT) OR
|
||||
// Options.Allow = AllowUsers(..., BCRYPT) OR
|
||||
// OPtions.Allow = AllowUsersFile(..., BCRYPT)
|
||||
//
|
||||
// Default(..., BCRYPT) OR
|
||||
// Load(..., BCRYPT) OR
|
||||
// Options.Allow = AllowUsers(..., BCRYPT) OR
|
||||
// OPtions.Allow = AllowUsersFile(..., BCRYPT)
|
||||
func BCRYPT(opts *UserAuthOptions) {
|
||||
opts.ComparePassword = func(stored, userPassword string) bool {
|
||||
err := bcrypt.CompareHashAndPassword([]byte(stored), []byte(userPassword))
|
||||
@@ -75,10 +76,11 @@ func toUserAuthOptions(opts []UserAuthOption) (options UserAuthOptions) {
|
||||
|
||||
// AllowUsers is an AuthFunc which authenticates user input based on a (static) user list.
|
||||
// The "users" input parameter can be one of the following forms:
|
||||
// map[string]string e.g. {username: password, username: password...}.
|
||||
// []map[string]interface{} e.g. []{"username": "...", "password": "...", "other_field": ...}, ...}.
|
||||
// []T which T completes the User interface.
|
||||
// []T which T contains at least Username and Password fields.
|
||||
//
|
||||
// map[string]string e.g. {username: password, username: password...}.
|
||||
// []map[string]interface{} e.g. []{"username": "...", "password": "...", "other_field": ...}, ...}.
|
||||
// []T which T completes the User interface.
|
||||
// []T which T contains at least Username and Password fields.
|
||||
//
|
||||
// Usage:
|
||||
// New(Options{Allow: AllowUsers(..., [BCRYPT])})
|
||||
@@ -155,15 +157,17 @@ func userMap(usernamePassword map[string]string, opts ...UserAuthOption) AuthFun
|
||||
// loaded from a file on initialization.
|
||||
//
|
||||
// Example Code:
|
||||
// New(Options{Allow: AllowUsersFile("users.yml", BCRYPT)})
|
||||
//
|
||||
// New(Options{Allow: AllowUsersFile("users.yml", BCRYPT)})
|
||||
//
|
||||
// The users.yml file looks like the following:
|
||||
// - username: kataras
|
||||
// password: kataras_pass
|
||||
// age: 27
|
||||
// role: admin
|
||||
// - username: makis
|
||||
// password: makis_password
|
||||
// ...
|
||||
// - username: kataras
|
||||
// password: kataras_pass
|
||||
// age: 27
|
||||
// role: admin
|
||||
// - username: makis
|
||||
// password: makis_password
|
||||
// ...
|
||||
func AllowUsersFile(jsonOrYamlFilename string, opts ...UserAuthOption) AuthFunc {
|
||||
var (
|
||||
usernamePassword map[string]string
|
||||
|
||||
@@ -2,7 +2,6 @@ package basicauth
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"reflect"
|
||||
"testing"
|
||||
@@ -164,7 +163,7 @@ func TestAllowUsers(t *testing.T) {
|
||||
|
||||
// Test YAML user loading with b-encrypted passwords.
|
||||
func TestAllowUsersFile(t *testing.T) {
|
||||
f, err := ioutil.TempFile("", "*users.yml")
|
||||
f, err := os.CreateTemp("", "*users.yml")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user