opencloud/services/graph/pkg/identity/backend.go

package identity

//go:generate $GOWRAP gen -g -i Backend -t ./backend_prometheus.tmpl -o backend_prometheus.go
//go:generate $GOWRAP gen -g -i EducationBackend -t ./backend_prometheus.tmpl -o education_backend_prometheus.go

import (
	"context"
	"net/url"
	"time"

	"github.com/CiscoM31/godata"
	cs3group "github.com/cs3org/go-cs3apis/cs3/identity/group/v1beta1"
	cs3user "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
	libregraph "github.com/opencloud-eu/libre-graph-api-go"
	"github.com/opencloud-eu/opencloud/services/graph/pkg/errorcode"
)

// Errors used by the interfaces
var (
	// ErrReadOnly signals that the backend is set to read only.
	ErrReadOnly = errorcode.New(errorcode.NotAllowed, "server is configured read-only")
	// ErrNotFound signals that the requested resource was not found.
	ErrNotFound = errorcode.New(errorcode.ItemNotFound, "not found")
	// ErrTooManyResults signals that multiple results were found when only one was expected
	ErrTooManyResults = errorcode.New(errorcode.TooManyResults, "too many results")
	// ErrUnsupportedFilter signals that the requested filter is not supported by the backend.
	ErrUnsupportedFilter = godata.NotImplementedError("unsupported filter")
)

const (
	UserTypeMember    = "Member"
	UserTypeGuest     = "Guest"
	UserTypeFederated = "Federated"
)

const (
	MetricOpCreateUser            = "create-user"
	MetricOpDeleteUser            = "delete-user"
	MetricOpUpdateUser            = "update-user"
	MetricOpGetUser               = "get-user"
	MetricOpGetUsers              = "get-users"
	MetricOpFilterUsers           = "filter-users"
	MetricOpUpdateLastSignInDate  = "update-last-signin-date"
	MetricOpGetGroup              = "get-group"
	MetricOpGetGroups             = "get-groups"
	MetricOpCreateGroup           = "create-group"
	MetricOpDeleteGroup           = "delete-group"
	MetricOpUpdateGroupName       = "update-group-name"
	MetricOpAddMembersToGroup     = "add-members-to-group"
	MetricOpRemoveMemberFromGroup = "remove-member-from-group"
	MetricOpGetGroupMembers       = "get-group-members"
)

// Backend defines the Interface for an IdentityBackend implementation
type Backend interface {
	// CreateUser creates a given user in the identity backend.
	CreateUser(ctx context.Context, user libregraph.User) (*libregraph.User, error)
	// DeleteUser deletes a given user, identified by username or id, from the backend
	DeleteUser(ctx context.Context, nameOrID string) error
	// UpdateUser applies changes to given user, identified by username or id
	UpdateUser(ctx context.Context, nameOrID string, user libregraph.UserUpdate) (*libregraph.User, error)
	GetUser(ctx context.Context, nameOrID string, oreq *godata.GoDataRequest) (*libregraph.User, error)
	GetUsers(ctx context.Context, oreq *godata.GoDataRequest) ([]*libregraph.User, error)
	// FilterUsers returns a list of users that match the filter
	FilterUsers(ctx context.Context, oreq *godata.GoDataRequest, filter *godata.ParseNode) ([]*libregraph.User, error)
	UpdateLastSignInDate(ctx context.Context, userID string, timestamp time.Time) error

	// CreateGroup creates the supplied group in the identity backend.
	CreateGroup(ctx context.Context, group libregraph.Group) (*libregraph.Group, error)
	// DeleteGroup deletes a given group, identified by id
	DeleteGroup(ctx context.Context, id string) error
	// UpdateGroupName updates the group name
	UpdateGroupName(ctx context.Context, groupID string, groupName string) error
	GetGroup(ctx context.Context, nameOrID string, queryParam url.Values) (*libregraph.Group, error)
	GetGroups(ctx context.Context, oreq *godata.GoDataRequest) ([]*libregraph.Group, error)
	// GetGroupMembers list all members of a group
	GetGroupMembers(ctx context.Context, id string, oreq *godata.GoDataRequest) ([]*libregraph.User, error)
	// AddMembersToGroup adds new members (reference by a slice of IDs) to supplied group in the identity backend.
	AddMembersToGroup(ctx context.Context, groupID string, memberID []string) error
	// RemoveMemberFromGroup removes a single member (by ID) from a group
	RemoveMemberFromGroup(ctx context.Context, groupID string, memberID string) error
}

const (
	MetricOpCreateEducationSchool             = "create-school"
	MetricOpUpdateEducationSchool             = "update-school"
	MetricOpDeleteEducationSchool             = "delete-school"
	MetricOpGetEducationSchool                = "get-school"
	MetricOpGetEducationSchools               = "get-schools"
	MetricOpFilterEducationSchoolsByAttribute = "filter-schools-byattr"
	MetricOpAddUsersToEducationSchool         = "add-eduusers-to-school"
	MetricOpRemoveUserFromEducationSchool     = "remove-eduser-from-school"
	MetricOpGetEducationSchoolClasses         = "get-school-classes"
	MetricOpAddClassesToEducationSchool       = "add-classes-to-school"
	MetricOpRemoveClassFromEducationSchool    = "remove-class-from-school"
	MetricOpAddTeacherToEducationClass        = "add-teacher-to-class"
	MetricOpCreateEducationUser               = "create-eduser"
	MetricOpDeleteEducationClass              = "delete-class"
	MetricOpDeleteEducationUser               = "delete-eduser"
	MetricOpFilterEducationUsersByAttribute   = "filter-edusers"
	MetricOpGetEducationClass                 = "get-class"
	MetricOpGetEducationClassMembers          = "get-class-members"
	MetricOpGetEducationClassTeachers         = "get-class-teachers"
	MetricOpGetEducationClasses               = "get-classes"
	MetricOpGetEducationSchoolUsers           = "get-school-edusers"
	MetricOpGetEducationUser                  = "get-eduser"
	MetricOpGetEducationUsers                 = "get-edusers"
	MetricOpUpdateEducationUser               = "update-eduser"
	MetricOpRemoveTeacherFromEducationClass   = "remove-teacher-from-class"
	MetricOpUpdateEducationClass              = "update-class"
	MetricOpCreateEducationClass              = "create-class"
)

// EducationBackend defines the Interface for an EducationBackend implementation
type EducationBackend interface {
	// CreateEducationSchool creates the supplied school in the identity backend.
	CreateEducationSchool(ctx context.Context, group libregraph.EducationSchool) (*libregraph.EducationSchool, error)
	// DeleteEducationSchool deletes a given school, identified by id
	DeleteEducationSchool(ctx context.Context, id string) error
	// GetEducationSchool reads a given school by id
	GetEducationSchool(ctx context.Context, nameOrID string) (*libregraph.EducationSchool, error)
	// GetEducationSchools lists all schools
	GetEducationSchools(ctx context.Context) ([]*libregraph.EducationSchool, error)
	// FilterEducationSchoolsByAttribute list all schools where an attribute matches a value, e.g. all schools with a given externalId
	FilterEducationSchoolsByAttribute(ctx context.Context, attr, value string) ([]*libregraph.EducationSchool, error)
	// UpdateEducationSchool updates attributes of a school
	UpdateEducationSchool(ctx context.Context, numberOrID string, school libregraph.EducationSchool) (*libregraph.EducationSchool, error)
	// GetEducationSchoolUsers lists all members of a school
	GetEducationSchoolUsers(ctx context.Context, id string) ([]*libregraph.EducationUser, error)
	// AddUsersToEducationSchool adds new members (reference by a slice of IDs) to supplied school in the identity backend.
	AddUsersToEducationSchool(ctx context.Context, schoolID string, memberID []string) error
	// RemoveUserFromEducationSchool removes a single member (by ID) from a school
	RemoveUserFromEducationSchool(ctx context.Context, schoolID string, memberID string) error

	// GetEducationSchoolClasses lists all classes in a school
	GetEducationSchoolClasses(ctx context.Context, schoolNumberOrID string) ([]*libregraph.EducationClass, error)
	// AddClassesToEducationSchool adds new classes (referenced by a slice of IDs) to supplied school in the identity backend.
	AddClassesToEducationSchool(ctx context.Context, schoolNumberOrID string, memberIDs []string) error
	// RemoveClassFromEducationSchool removes a class from a school.
	RemoveClassFromEducationSchool(ctx context.Context, schoolNumberOrID string, memberID string) error

	// GetEducationClasses lists all classes
	GetEducationClasses(ctx context.Context) ([]*libregraph.EducationClass, error)
	// GetEducationClass reads a given class by id
	GetEducationClass(ctx context.Context, namedOrID string) (*libregraph.EducationClass, error)
	// CreateEducationClass creates the supplied education class in the identity backend.
	CreateEducationClass(ctx context.Context, class libregraph.EducationClass) (*libregraph.EducationClass, error)
	// DeleteEducationClass deletes the supplied education class in the identity backend.
	DeleteEducationClass(ctx context.Context, nameOrID string) error
	// GetEducationClassMembers returns the EducationUser members for an EducationClass
	GetEducationClassMembers(ctx context.Context, nameOrID string) ([]*libregraph.EducationUser, error)
	// UpdateEducationClass updates properties of the supplied class in the identity backend.
	UpdateEducationClass(ctx context.Context, id string, class libregraph.EducationClass) (*libregraph.EducationClass, error)

	// CreateEducationUser creates a given education user in the identity backend.
	CreateEducationUser(ctx context.Context, user libregraph.EducationUser) (*libregraph.EducationUser, error)
	// DeleteEducationUser deletes a given education user, identified by username or id, from the backend
	DeleteEducationUser(ctx context.Context, nameOrID string) error
	// UpdateEducationUser applies changes to given education user, identified by username or id
	UpdateEducationUser(ctx context.Context, nameOrID string, user libregraph.EducationUser) (*libregraph.EducationUser, error)
	// GetEducationUser reads an education user by id or name
	GetEducationUser(ctx context.Context, nameOrID string) (*libregraph.EducationUser, error)
	// GetEducationUsers lists all education users
	GetEducationUsers(ctx context.Context) ([]*libregraph.EducationUser, error)
	// FilterEducationUsersByAttribute list all education users where and attribute matches a value, e.g. all users with a given externalid
	FilterEducationUsersByAttribute(ctx context.Context, attr, value string) ([]*libregraph.EducationUser, error)

	// GetEducationClassTeachers returns the EducationUser teachers for an EducationClass
	GetEducationClassTeachers(ctx context.Context, classID string) ([]*libregraph.EducationUser, error)
	// AddTeacherToEducationClass adds a teacher (by ID) to class in the identity backend.
	AddTeacherToEducationClass(ctx context.Context, classID string, teacherID string) error
	// RemoveTeacherFromEducationClass removes teacher (by ID) from a class
	RemoveTeacherFromEducationClass(ctx context.Context, classID string, teacherID string) error
}

// CreateUserModelFromCS3 converts a cs3 User object into a libregraph.User
func CreateUserModelFromCS3(u *cs3user.User) *libregraph.User {
	if u.GetId() == nil {
		u.Id = &cs3user.UserId{}
	}
	userType := CS3UserTypeToGraph(u.GetId().GetType())
	user := &libregraph.User{
		Identities: []libregraph.ObjectIdentity{{
			Issuer:           &u.GetId().Idp,
			IssuerAssignedId: &u.GetId().OpaqueId,
		}},
		UserType:                 &userType,
		DisplayName:              u.GetDisplayName(),
		Mail:                     &u.Mail,
		OnPremisesSamAccountName: u.GetUsername(),
		Id:                       &u.GetId().OpaqueId,
	}
	if u.GetId().GetType() == cs3user.UserType_USER_TYPE_FEDERATED {
		ocmUserId := u.GetId().GetOpaqueId() + "@" + u.GetId().GetIdp()
		user.Id = &ocmUserId
	}
	return user
}

func CS3UserTypeToGraph(cs3type cs3user.UserType) string {
	switch cs3type {
	case cs3user.UserType_USER_TYPE_PRIMARY:
		return UserTypeMember
	case cs3user.UserType_USER_TYPE_FEDERATED:
		return UserTypeFederated
	case cs3user.UserType_USER_TYPE_GUEST:
		return UserTypeGuest
	}
	return "unknown"
}

// CreateGroupModelFromCS3 converts a cs3 Group object into a libregraph.Group
func CreateGroupModelFromCS3(g *cs3group.Group) *libregraph.Group {
	if g.GetId() == nil {
		g.Id = &cs3group.GroupId{}
	}
	return &libregraph.Group{
		Id:          &g.Id.OpaqueId,
		DisplayName: &g.GroupName,
	}
}