From e2ba32473b5a55aad4c429454b12227cce890777 Mon Sep 17 00:00:00 2001 From: Daniel Valdivia Date: Thu, 2 Apr 2020 15:54:34 -0700 Subject: [PATCH] Check Session Endpoint (#10) --- models/session_response.go | 114 +++++++++++++++ portal-ui/src/screens/Console/Console.tsx | 9 ++ restapi/configure_mcs.go | 2 + restapi/embedded_spec.go | 68 +++++++++ restapi/operations/mcs_api.go | 12 ++ restapi/operations/user_api/session_check.go | 90 ++++++++++++ .../user_api/session_check_parameters.go | 62 ++++++++ .../user_api/session_check_responses.go | 133 ++++++++++++++++++ .../user_api/session_check_urlbuilder.go | 101 +++++++++++++ restapi/user_session.go | 42 ++++++ swagger.yml | 23 ++- 11 files changed, 655 insertions(+), 1 deletion(-) create mode 100644 models/session_response.go create mode 100644 restapi/operations/user_api/session_check.go create mode 100644 restapi/operations/user_api/session_check_parameters.go create mode 100644 restapi/operations/user_api/session_check_responses.go create mode 100644 restapi/operations/user_api/session_check_urlbuilder.go create mode 100644 restapi/user_session.go diff --git a/models/session_response.go b/models/session_response.go new file mode 100644 index 000000000..9f8e4cd37 --- /dev/null +++ b/models/session_response.go @@ -0,0 +1,114 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// This file is part of MinIO Console Server +// Copyright (c) 2020 MinIO, Inc. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "encoding/json" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" + "github.com/go-openapi/validate" +) + +// SessionResponse session response +// +// swagger:model sessionResponse +type SessionResponse struct { + + // status + // Enum: [ok] + Status string `json:"status,omitempty"` +} + +// Validate validates this session response +func (m *SessionResponse) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateStatus(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +var sessionResponseTypeStatusPropEnum []interface{} + +func init() { + var res []string + if err := json.Unmarshal([]byte(`["ok"]`), &res); err != nil { + panic(err) + } + for _, v := range res { + sessionResponseTypeStatusPropEnum = append(sessionResponseTypeStatusPropEnum, v) + } +} + +const ( + + // SessionResponseStatusOk captures enum value "ok" + SessionResponseStatusOk string = "ok" +) + +// prop value enum +func (m *SessionResponse) validateStatusEnum(path, location string, value string) error { + if err := validate.Enum(path, location, value, sessionResponseTypeStatusPropEnum); err != nil { + return err + } + return nil +} + +func (m *SessionResponse) validateStatus(formats strfmt.Registry) error { + + if swag.IsZero(m.Status) { // not required + return nil + } + + // value enum + if err := m.validateStatusEnum("status", "body", m.Status); err != nil { + return err + } + + return nil +} + +// MarshalBinary interface implementation +func (m *SessionResponse) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *SessionResponse) UnmarshalBinary(b []byte) error { + var res SessionResponse + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/portal-ui/src/screens/Console/Console.tsx b/portal-ui/src/screens/Console/Console.tsx index a3e91ec2a..17c72d6ba 100644 --- a/portal-ui/src/screens/Console/Console.tsx +++ b/portal-ui/src/screens/Console/Console.tsx @@ -169,6 +169,15 @@ class Console extends React.Component< > { componentDidMount(): void { //TODO: verify the session is still valid + api + .invoke("GET", `/api/v1/session`) + .then(res => { + console.log(res); + }) + .catch(err => { + storage.removeItem("token"); + history.push("/"); + }); } render() { diff --git a/restapi/configure_mcs.go b/restapi/configure_mcs.go index 263fe3587..988d12a97 100644 --- a/restapi/configure_mcs.go +++ b/restapi/configure_mcs.go @@ -85,6 +85,8 @@ func configureAPI(api *operations.McsAPI) http.Handler { registerServiceHandlers(api) // Register profiling handlers registerProfilingHandler(api) + // Register session handlers + registerSessionHandlers(api) api.PreServerShutdown = func() {} diff --git a/restapi/embedded_spec.go b/restapi/embedded_spec.go index cc8451737..0bc0a7505 100644 --- a/restapi/embedded_spec.go +++ b/restapi/embedded_spec.go @@ -780,6 +780,29 @@ func init() { } } }, + "/api/v1/session": { + "get": { + "tags": [ + "UserAPI" + ], + "summary": "Endpoint to check if your session is still valid", + "operationId": "SessionCheck", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sessionResponse" + } + }, + "default": { + "description": "Generic error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, "/api/v1/set-policy/{name}": { "put": { "tags": [ @@ -1267,6 +1290,17 @@ func init() { } } }, + "sessionResponse": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "ok" + ] + } + } + }, "setBucketPolicyRequest": { "type": "object", "required": [ @@ -2161,6 +2195,29 @@ func init() { } } }, + "/api/v1/session": { + "get": { + "tags": [ + "UserAPI" + ], + "summary": "Endpoint to check if your session is still valid", + "operationId": "SessionCheck", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/sessionResponse" + } + }, + "default": { + "description": "Generic error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, "/api/v1/set-policy/{name}": { "put": { "tags": [ @@ -2648,6 +2705,17 @@ func init() { } } }, + "sessionResponse": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "ok" + ] + } + } + }, "setBucketPolicyRequest": { "type": "object", "required": [ diff --git a/restapi/operations/mcs_api.go b/restapi/operations/mcs_api.go index c7829ec8f..c99900533 100644 --- a/restapi/operations/mcs_api.go +++ b/restapi/operations/mcs_api.go @@ -132,6 +132,9 @@ func NewMcsAPI(spec *loads.Document) *McsAPI { AdminAPIRestartServiceHandler: admin_api.RestartServiceHandlerFunc(func(params admin_api.RestartServiceParams, principal *models.Principal) middleware.Responder { return middleware.NotImplemented("operation admin_api.RestartService has not yet been implemented") }), + UserAPISessionCheckHandler: user_api.SessionCheckHandlerFunc(func(params user_api.SessionCheckParams, principal *models.Principal) middleware.Responder { + return middleware.NotImplemented("operation user_api.SessionCheck has not yet been implemented") + }), AdminAPISetConfigHandler: admin_api.SetConfigHandlerFunc(func(params admin_api.SetConfigParams, principal *models.Principal) middleware.Responder { return middleware.NotImplemented("operation admin_api.SetConfig has not yet been implemented") }), @@ -236,6 +239,8 @@ type McsAPI struct { AdminAPIRemovePolicyHandler admin_api.RemovePolicyHandler // AdminAPIRestartServiceHandler sets the operation handler for the restart service operation AdminAPIRestartServiceHandler admin_api.RestartServiceHandler + // UserAPISessionCheckHandler sets the operation handler for the session check operation + UserAPISessionCheckHandler user_api.SessionCheckHandler // AdminAPISetConfigHandler sets the operation handler for the set config operation AdminAPISetConfigHandler admin_api.SetConfigHandler // AdminAPISetPolicyHandler sets the operation handler for the set policy operation @@ -384,6 +389,9 @@ func (o *McsAPI) Validate() error { if o.AdminAPIRestartServiceHandler == nil { unregistered = append(unregistered, "admin_api.RestartServiceHandler") } + if o.UserAPISessionCheckHandler == nil { + unregistered = append(unregistered, "user_api.SessionCheckHandler") + } if o.AdminAPISetConfigHandler == nil { unregistered = append(unregistered, "admin_api.SetConfigHandler") } @@ -585,6 +593,10 @@ func (o *McsAPI) initHandlerCache() { o.handlers["POST"] = make(map[string]http.Handler) } o.handlers["POST"]["/api/v1/service/restart"] = admin_api.NewRestartService(o.context, o.AdminAPIRestartServiceHandler) + if o.handlers["GET"] == nil { + o.handlers["GET"] = make(map[string]http.Handler) + } + o.handlers["GET"]["/api/v1/session"] = user_api.NewSessionCheck(o.context, o.UserAPISessionCheckHandler) if o.handlers["PUT"] == nil { o.handlers["PUT"] = make(map[string]http.Handler) } diff --git a/restapi/operations/user_api/session_check.go b/restapi/operations/user_api/session_check.go new file mode 100644 index 000000000..1feb8fcc6 --- /dev/null +++ b/restapi/operations/user_api/session_check.go @@ -0,0 +1,90 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// This file is part of MinIO Console Server +// Copyright (c) 2020 MinIO, Inc. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package user_api + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the generate command + +import ( + "net/http" + + "github.com/go-openapi/runtime/middleware" + + "github.com/minio/m3/mcs/models" +) + +// SessionCheckHandlerFunc turns a function with the right signature into a session check handler +type SessionCheckHandlerFunc func(SessionCheckParams, *models.Principal) middleware.Responder + +// Handle executing the request and returning a response +func (fn SessionCheckHandlerFunc) Handle(params SessionCheckParams, principal *models.Principal) middleware.Responder { + return fn(params, principal) +} + +// SessionCheckHandler interface for that can handle valid session check params +type SessionCheckHandler interface { + Handle(SessionCheckParams, *models.Principal) middleware.Responder +} + +// NewSessionCheck creates a new http.Handler for the session check operation +func NewSessionCheck(ctx *middleware.Context, handler SessionCheckHandler) *SessionCheck { + return &SessionCheck{Context: ctx, Handler: handler} +} + +/*SessionCheck swagger:route GET /api/v1/session UserAPI sessionCheck + +Endpoint to check if your session is still valid + +*/ +type SessionCheck struct { + Context *middleware.Context + Handler SessionCheckHandler +} + +func (o *SessionCheck) ServeHTTP(rw http.ResponseWriter, r *http.Request) { + route, rCtx, _ := o.Context.RouteInfo(r) + if rCtx != nil { + r = rCtx + } + var Params = NewSessionCheckParams() + + uprinc, aCtx, err := o.Context.Authorize(r, route) + if err != nil { + o.Context.Respond(rw, r, route.Produces, route, err) + return + } + if aCtx != nil { + r = aCtx + } + var principal *models.Principal + if uprinc != nil { + principal = uprinc.(*models.Principal) // this is really a models.Principal, I promise + } + + if err := o.Context.BindValidRequest(r, route, &Params); err != nil { // bind params + o.Context.Respond(rw, r, route.Produces, route, err) + return + } + + res := o.Handler.Handle(Params, principal) // actually handle the request + + o.Context.Respond(rw, r, route.Produces, route, res) + +} diff --git a/restapi/operations/user_api/session_check_parameters.go b/restapi/operations/user_api/session_check_parameters.go new file mode 100644 index 000000000..e0fab6037 --- /dev/null +++ b/restapi/operations/user_api/session_check_parameters.go @@ -0,0 +1,62 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// This file is part of MinIO Console Server +// Copyright (c) 2020 MinIO, Inc. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package user_api + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "net/http" + + "github.com/go-openapi/errors" + "github.com/go-openapi/runtime/middleware" +) + +// NewSessionCheckParams creates a new SessionCheckParams object +// no default values defined in spec. +func NewSessionCheckParams() SessionCheckParams { + + return SessionCheckParams{} +} + +// SessionCheckParams contains all the bound params for the session check operation +// typically these are obtained from a http.Request +// +// swagger:parameters SessionCheck +type SessionCheckParams struct { + + // HTTP Request Object + HTTPRequest *http.Request `json:"-"` +} + +// BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface +// for simple values it will use straight method calls. +// +// To ensure default values, the struct must have been initialized with NewSessionCheckParams() beforehand. +func (o *SessionCheckParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error { + var res []error + + o.HTTPRequest = r + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} diff --git a/restapi/operations/user_api/session_check_responses.go b/restapi/operations/user_api/session_check_responses.go new file mode 100644 index 000000000..d4d4ee832 --- /dev/null +++ b/restapi/operations/user_api/session_check_responses.go @@ -0,0 +1,133 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// This file is part of MinIO Console Server +// Copyright (c) 2020 MinIO, Inc. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package user_api + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "net/http" + + "github.com/go-openapi/runtime" + + "github.com/minio/m3/mcs/models" +) + +// SessionCheckOKCode is the HTTP code returned for type SessionCheckOK +const SessionCheckOKCode int = 200 + +/*SessionCheckOK A successful response. + +swagger:response sessionCheckOK +*/ +type SessionCheckOK struct { + + /* + In: Body + */ + Payload *models.SessionResponse `json:"body,omitempty"` +} + +// NewSessionCheckOK creates SessionCheckOK with default headers values +func NewSessionCheckOK() *SessionCheckOK { + + return &SessionCheckOK{} +} + +// WithPayload adds the payload to the session check o k response +func (o *SessionCheckOK) WithPayload(payload *models.SessionResponse) *SessionCheckOK { + o.Payload = payload + return o +} + +// SetPayload sets the payload to the session check o k response +func (o *SessionCheckOK) SetPayload(payload *models.SessionResponse) { + o.Payload = payload +} + +// WriteResponse to the client +func (o *SessionCheckOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer) { + + rw.WriteHeader(200) + if o.Payload != nil { + payload := o.Payload + if err := producer.Produce(rw, payload); err != nil { + panic(err) // let the recovery middleware deal with this + } + } +} + +/*SessionCheckDefault Generic error response. + +swagger:response sessionCheckDefault +*/ +type SessionCheckDefault struct { + _statusCode int + + /* + In: Body + */ + Payload *models.Error `json:"body,omitempty"` +} + +// NewSessionCheckDefault creates SessionCheckDefault with default headers values +func NewSessionCheckDefault(code int) *SessionCheckDefault { + if code <= 0 { + code = 500 + } + + return &SessionCheckDefault{ + _statusCode: code, + } +} + +// WithStatusCode adds the status to the session check default response +func (o *SessionCheckDefault) WithStatusCode(code int) *SessionCheckDefault { + o._statusCode = code + return o +} + +// SetStatusCode sets the status to the session check default response +func (o *SessionCheckDefault) SetStatusCode(code int) { + o._statusCode = code +} + +// WithPayload adds the payload to the session check default response +func (o *SessionCheckDefault) WithPayload(payload *models.Error) *SessionCheckDefault { + o.Payload = payload + return o +} + +// SetPayload sets the payload to the session check default response +func (o *SessionCheckDefault) SetPayload(payload *models.Error) { + o.Payload = payload +} + +// WriteResponse to the client +func (o *SessionCheckDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer) { + + rw.WriteHeader(o._statusCode) + if o.Payload != nil { + payload := o.Payload + if err := producer.Produce(rw, payload); err != nil { + panic(err) // let the recovery middleware deal with this + } + } +} diff --git a/restapi/operations/user_api/session_check_urlbuilder.go b/restapi/operations/user_api/session_check_urlbuilder.go new file mode 100644 index 000000000..91022dcfa --- /dev/null +++ b/restapi/operations/user_api/session_check_urlbuilder.go @@ -0,0 +1,101 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// This file is part of MinIO Console Server +// Copyright (c) 2020 MinIO, Inc. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . +// + +package user_api + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the generate command + +import ( + "errors" + "net/url" + golangswaggerpaths "path" +) + +// SessionCheckURL generates an URL for the session check operation +type SessionCheckURL struct { + _basePath string +} + +// WithBasePath sets the base path for this url builder, only required when it's different from the +// base path specified in the swagger spec. +// When the value of the base path is an empty string +func (o *SessionCheckURL) WithBasePath(bp string) *SessionCheckURL { + o.SetBasePath(bp) + return o +} + +// SetBasePath sets the base path for this url builder, only required when it's different from the +// base path specified in the swagger spec. +// When the value of the base path is an empty string +func (o *SessionCheckURL) SetBasePath(bp string) { + o._basePath = bp +} + +// Build a url path and query string +func (o *SessionCheckURL) Build() (*url.URL, error) { + var _result url.URL + + var _path = "/api/v1/session" + + _basePath := o._basePath + _result.Path = golangswaggerpaths.Join(_basePath, _path) + + return &_result, nil +} + +// Must is a helper function to panic when the url builder returns an error +func (o *SessionCheckURL) Must(u *url.URL, err error) *url.URL { + if err != nil { + panic(err) + } + if u == nil { + panic("url can't be nil") + } + return u +} + +// String returns the string representation of the path with query string +func (o *SessionCheckURL) String() string { + return o.Must(o.Build()).String() +} + +// BuildFull builds a full url with scheme, host, path and query string +func (o *SessionCheckURL) BuildFull(scheme, host string) (*url.URL, error) { + if scheme == "" { + return nil, errors.New("scheme is required for a full url on SessionCheckURL") + } + if host == "" { + return nil, errors.New("host is required for a full url on SessionCheckURL") + } + + base, err := o.Build() + if err != nil { + return nil, err + } + + base.Scheme = scheme + base.Host = host + return base, nil +} + +// StringFull returns the string representation of a complete url +func (o *SessionCheckURL) StringFull(scheme, host string) string { + return o.Must(o.BuildFull(scheme, host)).String() +} diff --git a/restapi/user_session.go b/restapi/user_session.go new file mode 100644 index 000000000..3bcd3f2de --- /dev/null +++ b/restapi/user_session.go @@ -0,0 +1,42 @@ +// This file is part of MinIO Console Server +// Copyright (c) 2020 MinIO, Inc. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package restapi + +import ( + "github.com/go-openapi/runtime/middleware" + "github.com/minio/m3/mcs/models" + "github.com/minio/m3/mcs/restapi/operations" + "github.com/minio/m3/mcs/restapi/operations/user_api" +) + +func registerSessionHandlers(api *operations.McsAPI) { + // session check + api.UserAPISessionCheckHandler = user_api.SessionCheckHandlerFunc(func(params user_api.SessionCheckParams, principal *models.Principal) middleware.Responder { + sessionResp := getSessionResponse() + return user_api.NewSessionCheckOK().WithPayload(sessionResp) + }) + +} + +// getSessionResponse returns only if the session is valid +func getSessionResponse() *models.SessionResponse { + // serialize output + sessionResp := &models.SessionResponse{ + Status: models.SessionResponseStatusOk, + } + return sessionResp +} diff --git a/swagger.yml b/swagger.yml index 1a5e4c226..380efcb1c 100644 --- a/swagger.yml +++ b/swagger.yml @@ -574,6 +574,21 @@ paths: $ref: "#/definitions/error" tags: - AdminAPI + /api/v1/session: + get: + summary: Endpoint to check if your session is still valid + operationId: SessionCheck + responses: + 200: + description: A successful response. + schema: + $ref: "#/definitions/sessionResponse" + default: + description: Generic error response. + schema: + $ref: "#/definitions/error" + tags: + - UserAPI definitions: bucketAccess: type: string @@ -920,4 +935,10 @@ definitions: - type properties: type: - $ref: "#/definitions/profilerType" \ No newline at end of file + $ref: "#/definitions/profilerType" + sessionResponse: + type: object + properties: + status: + type: string + enum: [ok]