643 lines
16 KiB
Go
643 lines
16 KiB
Go
package http
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"github.com/influxdata/influxdb/v2/kit/platform"
|
|
"github.com/influxdata/influxdb/v2/kit/platform/errors"
|
|
|
|
"github.com/influxdata/httprouter"
|
|
"github.com/influxdata/influxdb/v2"
|
|
icontext "github.com/influxdata/influxdb/v2/context"
|
|
"github.com/influxdata/influxdb/v2/pkg/httpc"
|
|
"go.uber.org/zap"
|
|
)
|
|
|
|
// UserBackend is all services and associated parameters required to construct
|
|
// the UserHandler.
|
|
type UserBackend struct {
|
|
errors.HTTPErrorHandler
|
|
log *zap.Logger
|
|
UserService influxdb.UserService
|
|
UserOperationLogService influxdb.UserOperationLogService
|
|
PasswordsService influxdb.PasswordsService
|
|
}
|
|
|
|
// NewUserBackend creates a UserBackend using information in the APIBackend.
|
|
func NewUserBackend(log *zap.Logger, b *APIBackend) *UserBackend {
|
|
return &UserBackend{
|
|
HTTPErrorHandler: b.HTTPErrorHandler,
|
|
log: log,
|
|
UserService: b.UserService,
|
|
UserOperationLogService: b.UserOperationLogService,
|
|
PasswordsService: b.PasswordsService,
|
|
}
|
|
}
|
|
|
|
// UserHandler represents an HTTP API handler for users.
|
|
type UserHandler struct {
|
|
*httprouter.Router
|
|
errors.HTTPErrorHandler
|
|
log *zap.Logger
|
|
UserService influxdb.UserService
|
|
UserOperationLogService influxdb.UserOperationLogService
|
|
PasswordsService influxdb.PasswordsService
|
|
}
|
|
|
|
const (
|
|
prefixUsers = "/api/v2/users"
|
|
prefixMe = "/api/v2/me"
|
|
mePasswordPath = "/api/v2/me/password"
|
|
usersIDPath = "/api/v2/users/:id"
|
|
usersPasswordPath = "/api/v2/users/:id/password"
|
|
)
|
|
|
|
// NewUserHandler returns a new instance of UserHandler.
|
|
func NewUserHandler(log *zap.Logger, b *UserBackend) *UserHandler {
|
|
h := &UserHandler{
|
|
Router: NewRouter(b.HTTPErrorHandler),
|
|
HTTPErrorHandler: b.HTTPErrorHandler,
|
|
log: log,
|
|
|
|
UserService: b.UserService,
|
|
UserOperationLogService: b.UserOperationLogService,
|
|
PasswordsService: b.PasswordsService,
|
|
}
|
|
|
|
h.HandlerFunc("POST", prefixUsers, h.handlePostUser)
|
|
h.HandlerFunc("GET", prefixUsers, h.handleGetUsers)
|
|
h.HandlerFunc("GET", usersIDPath, h.handleGetUser)
|
|
h.HandlerFunc("PATCH", usersIDPath, h.handlePatchUser)
|
|
h.HandlerFunc("DELETE", usersIDPath, h.handleDeleteUser)
|
|
// the POST doesn't need to be nested under users in this scheme
|
|
// seems worthwhile to make this a root resource in our HTTP API
|
|
// removes coupling with userid.
|
|
h.HandlerFunc("POST", usersPasswordPath, h.handlePostUserPassword)
|
|
h.HandlerFunc("PUT", usersPasswordPath, h.handlePutUserPassword)
|
|
|
|
h.HandlerFunc("GET", prefixMe, h.handleGetMe)
|
|
h.HandlerFunc("PUT", mePasswordPath, h.handlePutUserPassword)
|
|
|
|
return h
|
|
}
|
|
|
|
type passwordSetRequest struct {
|
|
Password string `json:"password"`
|
|
}
|
|
|
|
// handlePutPassword is the HTTP handler for the PUT /api/v2/users/:id/password
|
|
func (h *UserHandler) handlePostUserPassword(w http.ResponseWriter, r *http.Request) {
|
|
var body passwordSetRequest
|
|
err := json.NewDecoder(r.Body).Decode(&body)
|
|
if err != nil {
|
|
h.HandleHTTPError(r.Context(), &errors.Error{
|
|
Code: errors.EInvalid,
|
|
Err: err,
|
|
}, w)
|
|
return
|
|
}
|
|
|
|
params := httprouter.ParamsFromContext(r.Context())
|
|
userID, err := platform.IDFromString(params.ByName("id"))
|
|
if err != nil {
|
|
h.HandleHTTPError(r.Context(), &errors.Error{
|
|
Msg: "invalid user ID provided in route",
|
|
}, w)
|
|
return
|
|
}
|
|
|
|
err = h.PasswordsService.SetPassword(r.Context(), *userID, body.Password)
|
|
if err != nil {
|
|
h.HandleHTTPError(r.Context(), err, w)
|
|
return
|
|
}
|
|
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|
|
|
|
func (h *UserHandler) putPassword(ctx context.Context, w http.ResponseWriter, r *http.Request) (username string, err error) {
|
|
req, err := decodePasswordResetRequest(r)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
params := httprouter.ParamsFromContext(r.Context())
|
|
userID, err := platform.IDFromString(params.ByName("id"))
|
|
if err != nil {
|
|
h.HandleHTTPError(r.Context(), &errors.Error{
|
|
Msg: "invalid user ID provided in route",
|
|
}, w)
|
|
return
|
|
}
|
|
|
|
err = h.PasswordsService.CompareAndSetPassword(ctx, *userID, req.PasswordOld, req.PasswordNew)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return req.Username, nil
|
|
}
|
|
|
|
// handlePutPassword is the HTTP handler for the PUT /api/v2/users/:id/password
|
|
func (h *UserHandler) handlePutUserPassword(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
_, err := h.putPassword(ctx, w, r)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
h.log.Debug("User password updated")
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|
|
|
|
type passwordResetRequest struct {
|
|
Username string
|
|
PasswordOld string
|
|
PasswordNew string
|
|
}
|
|
|
|
type passwordResetRequestBody struct {
|
|
Password string `json:"password"`
|
|
}
|
|
|
|
func decodePasswordResetRequest(r *http.Request) (*passwordResetRequest, error) {
|
|
u, o, ok := r.BasicAuth()
|
|
if !ok {
|
|
return nil, fmt.Errorf("invalid basic auth")
|
|
}
|
|
|
|
pr := new(passwordResetRequestBody)
|
|
err := json.NewDecoder(r.Body).Decode(pr)
|
|
if err != nil {
|
|
return nil, &errors.Error{
|
|
Code: errors.EInvalid,
|
|
Err: err,
|
|
}
|
|
}
|
|
|
|
return &passwordResetRequest{
|
|
Username: u,
|
|
PasswordOld: o,
|
|
PasswordNew: pr.Password,
|
|
}, nil
|
|
}
|
|
|
|
// handlePostUser is the HTTP handler for the POST /api/v2/users route.
|
|
func (h *UserHandler) handlePostUser(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
req, err := decodePostUserRequest(ctx, r)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
|
|
if req.User.Status == "" {
|
|
req.User.Status = influxdb.Active
|
|
}
|
|
|
|
if err := h.UserService.CreateUser(ctx, req.User); err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
h.log.Debug("User created", zap.String("user", fmt.Sprint(req.User)))
|
|
|
|
if err := encodeResponse(ctx, w, http.StatusCreated, newUserResponse(req.User)); err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
}
|
|
|
|
type postUserRequest struct {
|
|
User *influxdb.User
|
|
}
|
|
|
|
func decodePostUserRequest(ctx context.Context, r *http.Request) (*postUserRequest, error) {
|
|
b := &influxdb.User{}
|
|
if err := json.NewDecoder(r.Body).Decode(b); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &postUserRequest{
|
|
User: b,
|
|
}, nil
|
|
}
|
|
|
|
// handleGetMe is the HTTP handler for the GET /api/v2/me.
|
|
func (h *UserHandler) handleGetMe(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
|
|
a, err := icontext.GetAuthorizer(ctx)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
|
|
id := a.GetUserID()
|
|
user, err := h.UserService.FindUserByID(ctx, id)
|
|
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
|
|
if err := encodeResponse(ctx, w, http.StatusOK, newUserResponse(user)); err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
}
|
|
}
|
|
|
|
// handleGetUser is the HTTP handler for the GET /api/v2/users/:id route.
|
|
func (h *UserHandler) handleGetUser(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
req, err := decodeGetUserRequest(ctx, r)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
|
|
b, err := h.UserService.FindUserByID(ctx, req.UserID)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
h.log.Debug("User retrieved", zap.String("user", fmt.Sprint(b)))
|
|
|
|
if err := encodeResponse(ctx, w, http.StatusOK, newUserResponse(b)); err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
}
|
|
|
|
type getUserRequest struct {
|
|
UserID platform.ID
|
|
}
|
|
|
|
func decodeGetUserRequest(ctx context.Context, r *http.Request) (*getUserRequest, error) {
|
|
params := httprouter.ParamsFromContext(ctx)
|
|
id := params.ByName("id")
|
|
if id == "" {
|
|
return nil, &errors.Error{
|
|
Code: errors.EInvalid,
|
|
Msg: "url missing id",
|
|
}
|
|
}
|
|
|
|
var i platform.ID
|
|
if err := i.DecodeFromString(id); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
req := &getUserRequest{
|
|
UserID: i,
|
|
}
|
|
|
|
return req, nil
|
|
}
|
|
|
|
// handleDeleteUser is the HTTP handler for the DELETE /api/v2/users/:id route.
|
|
func (h *UserHandler) handleDeleteUser(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
req, err := decodeDeleteUserRequest(ctx, r)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
|
|
if err := h.UserService.DeleteUser(ctx, req.UserID); err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
h.log.Debug("User deleted", zap.String("userID", fmt.Sprint(req.UserID)))
|
|
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|
|
|
|
type deleteUserRequest struct {
|
|
UserID platform.ID
|
|
}
|
|
|
|
func decodeDeleteUserRequest(ctx context.Context, r *http.Request) (*deleteUserRequest, error) {
|
|
params := httprouter.ParamsFromContext(ctx)
|
|
id := params.ByName("id")
|
|
if id == "" {
|
|
return nil, &errors.Error{
|
|
Code: errors.EInvalid,
|
|
Msg: "url missing id",
|
|
}
|
|
}
|
|
|
|
var i platform.ID
|
|
if err := i.DecodeFromString(id); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &deleteUserRequest{
|
|
UserID: i,
|
|
}, nil
|
|
}
|
|
|
|
type usersResponse struct {
|
|
Links map[string]string `json:"links"`
|
|
Users []*UserResponse `json:"users"`
|
|
}
|
|
|
|
func (us usersResponse) ToInfluxdb() []*influxdb.User {
|
|
users := make([]*influxdb.User, len(us.Users))
|
|
for i := range us.Users {
|
|
users[i] = &us.Users[i].User
|
|
}
|
|
return users
|
|
}
|
|
|
|
func newUsersResponse(users []*influxdb.User) *usersResponse {
|
|
res := usersResponse{
|
|
Links: map[string]string{
|
|
"self": "/api/v2/users",
|
|
},
|
|
Users: []*UserResponse{},
|
|
}
|
|
for _, user := range users {
|
|
res.Users = append(res.Users, newUserResponse(user))
|
|
}
|
|
return &res
|
|
}
|
|
|
|
// UserResponse is the response of user
|
|
type UserResponse struct {
|
|
Links map[string]string `json:"links"`
|
|
influxdb.User
|
|
}
|
|
|
|
func newUserResponse(u *influxdb.User) *UserResponse {
|
|
return &UserResponse{
|
|
Links: map[string]string{
|
|
"self": fmt.Sprintf("/api/v2/users/%s", u.ID),
|
|
"logs": fmt.Sprintf("/api/v2/users/%s/logs", u.ID),
|
|
},
|
|
User: *u,
|
|
}
|
|
}
|
|
|
|
// handleGetUsers is the HTTP handler for the GET /api/v2/users route.
|
|
func (h *UserHandler) handleGetUsers(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
req, err := decodeGetUsersRequest(ctx, r)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
|
|
users, _, err := h.UserService.FindUsers(ctx, req.filter, req.opts)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
h.log.Debug("Users retrieved", zap.String("users", fmt.Sprint(users)))
|
|
|
|
err = encodeResponse(ctx, w, http.StatusOK, newUsersResponse(users))
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
}
|
|
|
|
type getUsersRequest struct {
|
|
filter influxdb.UserFilter
|
|
opts influxdb.FindOptions
|
|
}
|
|
|
|
func decodeGetUsersRequest(ctx context.Context, r *http.Request) (*getUsersRequest, error) {
|
|
opts, err := influxdb.DecodeFindOptions(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
qp := r.URL.Query()
|
|
req := &getUsersRequest{
|
|
opts: *opts,
|
|
}
|
|
|
|
if userID := qp.Get("id"); userID != "" {
|
|
id, err := platform.IDFromString(userID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
req.filter.ID = id
|
|
}
|
|
|
|
if name := qp.Get("name"); name != "" {
|
|
req.filter.Name = &name
|
|
}
|
|
|
|
return req, nil
|
|
}
|
|
|
|
// handlePatchUser is the HTTP handler for the PATCH /api/v2/users/:id route.
|
|
func (h *UserHandler) handlePatchUser(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
req, err := decodePatchUserRequest(ctx, r)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
|
|
b, err := h.UserService.UpdateUser(ctx, req.UserID, req.Update)
|
|
if err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
h.log.Debug("Users updated", zap.String("user", fmt.Sprint(b)))
|
|
|
|
if err := encodeResponse(ctx, w, http.StatusOK, newUserResponse(b)); err != nil {
|
|
h.HandleHTTPError(ctx, err, w)
|
|
return
|
|
}
|
|
}
|
|
|
|
type patchUserRequest struct {
|
|
Update influxdb.UserUpdate
|
|
UserID platform.ID
|
|
}
|
|
|
|
func decodePatchUserRequest(ctx context.Context, r *http.Request) (*patchUserRequest, error) {
|
|
params := httprouter.ParamsFromContext(ctx)
|
|
id := params.ByName("id")
|
|
if id == "" {
|
|
return nil, &errors.Error{
|
|
Code: errors.EInvalid,
|
|
Msg: "url missing id",
|
|
}
|
|
}
|
|
|
|
var i platform.ID
|
|
if err := i.DecodeFromString(id); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var upd influxdb.UserUpdate
|
|
if err := json.NewDecoder(r.Body).Decode(&upd); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if err := upd.Valid(); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &patchUserRequest{
|
|
Update: upd,
|
|
UserID: i,
|
|
}, nil
|
|
}
|
|
|
|
// UserService connects to Influx via HTTP using tokens to manage users
|
|
type UserService struct {
|
|
Client *httpc.Client
|
|
// OpPrefix is the ops of not found error.
|
|
OpPrefix string
|
|
}
|
|
|
|
// FindMe returns user information about the owner of the token
|
|
func (s *UserService) FindMe(ctx context.Context, id platform.ID) (*influxdb.User, error) {
|
|
var res UserResponse
|
|
err := s.Client.
|
|
Get(prefixMe).
|
|
DecodeJSON(&res).
|
|
Do(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &res.User, nil
|
|
}
|
|
|
|
// FindUserByID returns a single user by ID.
|
|
func (s *UserService) FindUserByID(ctx context.Context, id platform.ID) (*influxdb.User, error) {
|
|
var res UserResponse
|
|
err := s.Client.
|
|
Get(prefixUsers, id.String()).
|
|
DecodeJSON(&res).
|
|
Do(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &res.User, nil
|
|
}
|
|
|
|
// FindUser returns the first user that matches filter.
|
|
func (s *UserService) FindUser(ctx context.Context, filter influxdb.UserFilter) (*influxdb.User, error) {
|
|
if filter.ID == nil && filter.Name == nil {
|
|
return nil, &errors.Error{
|
|
Code: errors.ENotFound,
|
|
Msg: "user not found",
|
|
}
|
|
}
|
|
users, n, err := s.FindUsers(ctx, filter)
|
|
if err != nil {
|
|
return nil, &errors.Error{
|
|
Op: s.OpPrefix + influxdb.OpFindUser,
|
|
Err: err,
|
|
}
|
|
}
|
|
|
|
if n == 0 {
|
|
return nil, &errors.Error{
|
|
Code: errors.ENotFound,
|
|
Op: s.OpPrefix + influxdb.OpFindUser,
|
|
Msg: "no results found",
|
|
}
|
|
}
|
|
|
|
return users[0], nil
|
|
}
|
|
|
|
// FindUsers returns a list of users that match filter and the total count of matching users.
|
|
// Additional options provide pagination & sorting.
|
|
func (s *UserService) FindUsers(ctx context.Context, filter influxdb.UserFilter, opt ...influxdb.FindOptions) ([]*influxdb.User, int, error) {
|
|
params := influxdb.FindOptionParams(opt...)
|
|
if filter.ID != nil {
|
|
params = append(params, [2]string{"id", filter.ID.String()})
|
|
}
|
|
if filter.Name != nil {
|
|
params = append(params, [2]string{"name", *filter.Name})
|
|
}
|
|
|
|
var r usersResponse
|
|
err := s.Client.
|
|
Get(prefixUsers).
|
|
QueryParams(params...).
|
|
DecodeJSON(&r).
|
|
Do(ctx)
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
|
|
us := r.ToInfluxdb()
|
|
return us, len(us), nil
|
|
}
|
|
|
|
// CreateUser creates a new user and sets u.ID with the new identifier.
|
|
func (s *UserService) CreateUser(ctx context.Context, u *influxdb.User) error {
|
|
return s.Client.
|
|
PostJSON(u, prefixUsers).
|
|
DecodeJSON(u).
|
|
Do(ctx)
|
|
}
|
|
|
|
// UpdateUser updates a single user with changeset.
|
|
// Returns the new user state after update.
|
|
func (s *UserService) UpdateUser(ctx context.Context, id platform.ID, upd influxdb.UserUpdate) (*influxdb.User, error) {
|
|
var res UserResponse
|
|
err := s.Client.
|
|
PatchJSON(upd, prefixUsers, id.String()).
|
|
DecodeJSON(&res).
|
|
Do(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &res.User, nil
|
|
}
|
|
|
|
// DeleteUser removes a user by ID.
|
|
func (s *UserService) DeleteUser(ctx context.Context, id platform.ID) error {
|
|
return s.Client.
|
|
Delete(prefixUsers, id.String()).
|
|
StatusFn(func(resp *http.Response) error {
|
|
return CheckErrorStatus(http.StatusNoContent, resp)
|
|
}).
|
|
Do(ctx)
|
|
}
|
|
|
|
func (s *UserService) FindPermissionForUser(ctx context.Context, uid platform.ID) (influxdb.PermissionSet, error) {
|
|
return nil, &errors.Error{
|
|
Code: errors.EInternal,
|
|
Msg: "not implemented",
|
|
}
|
|
}
|
|
|
|
// PasswordService is an http client to speak to the password service.
|
|
type PasswordService struct {
|
|
Client *httpc.Client
|
|
}
|
|
|
|
var _ influxdb.PasswordsService = (*PasswordService)(nil)
|
|
|
|
// SetPassword sets the user's password.
|
|
func (s *PasswordService) SetPassword(ctx context.Context, userID platform.ID, password string) error {
|
|
return s.Client.
|
|
PostJSON(passwordSetRequest{
|
|
Password: password,
|
|
}, prefixUsers, userID.String(), "password").
|
|
Do(ctx)
|
|
}
|
|
|
|
// ComparePassword compares the user new password with existing. Note: is not implemented.
|
|
func (s *PasswordService) ComparePassword(ctx context.Context, userID platform.ID, password string) error {
|
|
panic("not implemented")
|
|
}
|
|
|
|
// CompareAndSetPassword compares the old and new password and submits the new password if possible.
|
|
// Note: is not implemented.
|
|
func (s *PasswordService) CompareAndSetPassword(ctx context.Context, userID platform.ID, old string, new string) error {
|
|
panic("not implemented")
|
|
}
|