Skip to content

integrate validator pkg #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

integrate validator pkg #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions node-registrar/pkg/db/models.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ type Account struct {

type Farm struct {
FarmID uint64 `gorm:"primaryKey;autoIncrement" json:"farm_id"`
FarmName string `gorm:"size:40;not null;unique;check:farm_name <> ''" json:"farm_name" binding:"alphanum,required"`
TwinID uint64 `json:"twin_id" binding:"required" gorm:"not null;check:twin_id > 0"` // Farmer account reference
StellarAddress string `json:"stellar_address" binding:"required,startswith=G,len=56,alphanum,uppercase"`
FarmName string `gorm:"size:40;not null;unique;check:farm_name <> ''" json:"farm_name" validate:"alphanum,required"`
TwinID uint64 `json:"twin_id" validate:"required" gorm:"not null;check:twin_id > 0"` // Farmer account reference
StellarAddress string `json:"stellar_address" validate:"required,startswith=G,len=56,alphanum,uppercase"`
Dedicated bool `json:"dedicated"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Expand Down
65 changes: 46 additions & 19 deletions node-registrar/pkg/server/handlers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ import (
"time"

"github.com/gin-gonic/gin"
"github.com/go-playground/validator/v10"
"github.com/lib/pq"
"github.com/threefoldtech/tfgrid4-sdk-go/node-registrar/pkg/db"
)

var validate = validator.New()

const (
MaxTimestampDelta = 2 * time.Second
UptimeReportTimestampHintDrift int64 = 60
Expand Down Expand Up @@ -132,8 +135,8 @@ func (s Server) createFarmHandler(c *gin.Context) {
}

type UpdateFarmRequest struct {
FarmName string `json:"farm_name" binding:"max=40"`
StellarAddress string `json:"stellar_address" binding:"startswith=G,len=56,alphanum,uppercase"`
FarmName string `json:"farm_name" validate:"max=40"`
StellarAddress string `json:"stellar_address" validate:"startswith=G,len=56,alphanum,uppercase"`
}

// @Summary Update farm
Expand Down Expand Up @@ -282,14 +285,14 @@ func (s Server) getNodeHandler(c *gin.Context) {
}

type NodeRegistrationRequest struct {
TwinID uint64 `json:"twin_id" binding:"required,min=1"`
FarmID uint64 `json:"farm_id" binding:"required,min=1"`
Resources db.Resources `json:"resources" binding:"required"`
Location db.Location `json:"location" binding:"required"`
Interfaces []db.Interface `json:"interfaces" binding:"required"`
TwinID uint64 `json:"twin_id" validate:"required,min=1"`
FarmID uint64 `json:"farm_id" validate:"required,min=1"`
Resources db.Resources `json:"resources" validate:"required"`
Location db.Location `json:"location" validate:"required"`
Interfaces []db.Interface `json:"interfaces" validate:"required"`
SecureBoot bool `json:"secure_boot"`
Virtualized bool `json:"virtualized"`
SerialNumber string `json:"serial_number" binding:"required"`
SerialNumber string `json:"serial_number" validate:"required"`
}

// @Summary Register new node
Expand All @@ -311,6 +314,10 @@ func (s Server) registerNodeHandler(c *gin.Context) {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if err := validate.Struct(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}

ensureOwner(c, req.TwinID)
if c.IsAborted() {
Expand Down Expand Up @@ -345,13 +352,13 @@ func (s Server) registerNodeHandler(c *gin.Context) {
}

type UpdateNodeRequest struct {
FarmID uint64 `json:"farm_id" binding:"required,min=1"`
Resources db.Resources `json:"resources" binding:"required"`
Location db.Location `json:"location" binding:"required"`
Interfaces []db.Interface `json:"interfaces" binding:"required"`
FarmID uint64 `json:"farm_id" validate:"required,min=1"`
Resources db.Resources `json:"resources" validate:"required"`
Location db.Location `json:"location" validate:"required"`
Interfaces []db.Interface `json:"interfaces" validate:"required"`
SecureBoot bool `json:"secure_boot"`
Virtualized bool `json:"virtualized"`
SerialNumber string `json:"serial_number" binding:"required"`
SerialNumber string `json:"serial_number" validate:"required"`
}

// @Summary Update node
Expand Down Expand Up @@ -394,6 +401,10 @@ func (s *Server) updateNodeHandler(c *gin.Context) {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid request body"})
return
}
if err := validate.Struct(&req); err != nil {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}

updatedNode := db.Node{
FarmID: req.FarmID,
Expand Down Expand Up @@ -422,8 +433,8 @@ func (s *Server) updateNodeHandler(c *gin.Context) {
}

type UptimeReportRequest struct {
Uptime uint64 `json:"uptime" binding:"required"`
Timestamp int64 `json:"timestamp" binding:"required"`
Uptime uint64 `json:"uptime" validate:"required"`
Timestamp int64 `json:"timestamp" validate:"required"`
}

// @Summary Report node uptime
Expand Down Expand Up @@ -453,6 +464,10 @@ func (s *Server) uptimeReportHandler(c *gin.Context) {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if err := validate.Struct(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}

// Get node
node, err := s.db.GetNode(id)
Expand Down Expand Up @@ -507,11 +522,11 @@ func parseQueryParams(c *gin.Context, types_ ...interface{}) error {

// AccountRequest represents the request body for account operations
type AccountCreationRequest struct {
Timestamp int64 `json:"timestamp" binding:"required"`
PublicKey string `json:"public_key" binding:"required"` // base64 encoded
Timestamp int64 `json:"timestamp" validate:"required"`
PublicKey string `json:"public_key" validate:"required"` // base64 encoded
// the registrar expect a signature of a message with format `timestampStr:publicKeyBase64`
// - signature format: base64(ed25519_or_sr22519_signature)
Signature string `json:"signature" binding:"required"`
Signature string `json:"signature" validate:"required"`
Relays []string `json:"relays,omitempty"`
RMBEncKey string `json:"rmb_enc_key,omitempty"`
}
Expand All @@ -532,6 +547,10 @@ func (s *Server) createAccountHandler(c *gin.Context) {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if err := validate.Struct(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}

// Validate public key format
if !isValidPublicKey(req.PublicKey) {
Expand Down Expand Up @@ -631,6 +650,10 @@ func (s *Server) updateAccountHandler(c *gin.Context) {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "invalid request body"})
return
}
if err := validate.Struct(&req); err != nil {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}

err = s.db.UpdateAccount(twinID, req.Relays, req.RMBEncKey)
if err != nil {
Expand Down Expand Up @@ -713,7 +736,7 @@ func (s *Server) getAccountHandler(c *gin.Context) {
}

type ZOSVersionRequest struct {
Version string `json:"version" binding:"required,base64"`
Version string `json:"version" validate:"required,base64"`
}

// @Summary Set ZOS Version
Expand All @@ -740,6 +763,10 @@ func (s *Server) setZOSVersionHandler(c *gin.Context) {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if err := validate.Struct(&req); err != nil {
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}

if err := s.db.SetZOSVersion(req.Version); err != nil {
status := http.StatusInternalServerError
Expand Down
Loading