fixed.go

/* ****************************************************************************
 * Copyright 2020 51 Degrees Mobile Experts Limited (51degrees.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 * ***************************************************************************/

package access

import "net/http"

// Fixed is a implementation of common.Access for testing where a list
// of provided keys returns true, and all others return false.
type Fixed struct {
	validKeys map[string]bool // A list of the keys that are valid.
}

// NewFixed creates a new instance of the AccessFixed structure with the
// fixed list of keys provided the allowed keys.
func NewFixed(validKeys []string) *Fixed {
	var a Fixed

	m := make(map[string]bool)
	for _, k := range validKeys {
		m[k] = true
	}
	a.validKeys = m

	return &a
}

// GetAllowed validates access key is allowed.
func (a *Fixed) GetAllowed(accessKey string) (bool, error) {
	return a.validKeys[accessKey], nil
}

// GetAllowedHttp validates the access key in the request and handles any
// failures.
func (a *Fixed) GetAllowedHttp(w http.ResponseWriter, r *http.Request) bool {
	return GetAllowedHttp(w, r, a)
}