mirror of
https://github.com/zitadel/zitadel.git
synced 2025-07-11 22:38:31 +00:00

<!-- Please inform yourself about the contribution guidelines on submitting a PR here: https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#submit-a-pull-request-pr. Take note of how PR/commit titles should be written and replace the template texts in the sections below. Don't remove any of the sections. It is important that the commit history clearly shows what is changed and why. Important: By submitting a contribution you agree to the terms from our Licensing Policy as described here: https://github.com/zitadel/zitadel/blob/main/LICENSING.md#community-contributions. --> # Which Problems Are Solved These changes introduce resource-based API endpoints for managing instances and custom domains. There are 4 types of changes: - Endpoint implementation: consisting of the protobuf interface and the implementation of the endpoint. E.g: 606439a17227b629c1d018842dc3f1c569e4627a - (Integration) Tests: testing the implemented endpoint. E.g: cdfe1f0372b30cb74e34f0f23c6ada776e4477e9 - Fixes: Bugs found during development that are being fixed. E.g: acbbeedd3259b785948c1d702eb98f5810b3e60a - Miscellaneous: code needed to put everything together or that doesn't fit any of the above categories. E.g: 529df92abce1ffd69c0b3214bd835be404fd0de0 or 6802cb5468fbe24664ae6639fd3a40679222a2fd # How the Problems Are Solved _Ticked checkboxes indicate that the functionality is complete_ - [x] Instance - [x] Create endpoint - [x] Create endpoint tests - [x] Update endpoint - [x] Update endpoint tests - [x] Get endpoint - [x] Get endpoint tests - [x] Delete endpoint - [x] Delete endpoint tests - [x] Custom Domains - [x] Add custom domain - [x] Add custom domain tests - [x] Remove custom domain - [x] Remove custom domain tests - [x] List custom domains - [x] List custom domains tests - [x] Trusted Domains - [x] Add trusted domain - [x] Add trusted domain tests - [x] Remove trusted domain - [x] Remove trusted domain tests - [x] List trusted domains - [x] List trusted domains tests # Additional Changes When looking for instances (through the `ListInstances` endpoint) matching a given query, if you ask for the results to be order by a specific column, the query will fail due to a syntax error. This is fixed in acbbeedd3259b785948c1d702eb98f5810b3e60a . Further explanation can be found in the commit message # Additional Context - Relates to #9452 - CreateInstance has been excluded: https://github.com/zitadel/zitadel/issues/9930 - Permission checks / instance retrieval (middleware) needs to be changed to allow context based permission checks (https://github.com/zitadel/zitadel/issues/9929), required for ListInstances --------- Co-authored-by: Livio Spring <livio.a@gmail.com>
247 lines
7.7 KiB
Go
247 lines
7.7 KiB
Go
package instance
|
|
|
|
import (
|
|
"google.golang.org/protobuf/types/known/timestamppb"
|
|
|
|
"github.com/zitadel/zitadel/cmd/build"
|
|
filter "github.com/zitadel/zitadel/internal/api/grpc/filter/v2beta"
|
|
"github.com/zitadel/zitadel/internal/api/grpc/object/v2"
|
|
"github.com/zitadel/zitadel/internal/config/systemdefaults"
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
instance "github.com/zitadel/zitadel/pkg/grpc/instance/v2beta"
|
|
)
|
|
|
|
func InstancesToPb(instances []*query.Instance) []*instance.Instance {
|
|
list := []*instance.Instance{}
|
|
for _, instance := range instances {
|
|
list = append(list, ToProtoObject(instance))
|
|
}
|
|
return list
|
|
}
|
|
|
|
func ToProtoObject(inst *query.Instance) *instance.Instance {
|
|
return &instance.Instance{
|
|
Id: inst.ID,
|
|
Name: inst.Name,
|
|
Domains: DomainsToPb(inst.Domains),
|
|
Version: build.Version(),
|
|
ChangeDate: timestamppb.New(inst.ChangeDate),
|
|
CreationDate: timestamppb.New(inst.CreationDate),
|
|
}
|
|
}
|
|
|
|
func DomainsToPb(domains []*query.InstanceDomain) []*instance.Domain {
|
|
d := []*instance.Domain{}
|
|
for _, dm := range domains {
|
|
pbDomain := DomainToPb(dm)
|
|
d = append(d, pbDomain)
|
|
}
|
|
return d
|
|
}
|
|
|
|
func DomainToPb(d *query.InstanceDomain) *instance.Domain {
|
|
return &instance.Domain{
|
|
Domain: d.Domain,
|
|
Primary: d.IsPrimary,
|
|
Generated: d.IsGenerated,
|
|
InstanceId: d.InstanceID,
|
|
CreationDate: timestamppb.New(d.CreationDate),
|
|
}
|
|
}
|
|
|
|
func ListInstancesRequestToModel(req *instance.ListInstancesRequest, sysDefaults systemdefaults.SystemDefaults) (*query.InstanceSearchQueries, error) {
|
|
offset, limit, asc, err := filter.PaginationPbToQuery(sysDefaults, req.GetPagination())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
queries, err := instanceQueriesToModel(req.GetQueries())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &query.InstanceSearchQueries{
|
|
SearchRequest: query.SearchRequest{
|
|
Offset: offset,
|
|
Limit: limit,
|
|
Asc: asc,
|
|
SortingColumn: fieldNameToInstanceColumn(req.GetSortingColumn()),
|
|
},
|
|
Queries: queries,
|
|
}, nil
|
|
|
|
}
|
|
|
|
func fieldNameToInstanceColumn(fieldName instance.FieldName) query.Column {
|
|
switch fieldName {
|
|
case instance.FieldName_FIELD_NAME_ID:
|
|
return query.InstanceColumnID
|
|
case instance.FieldName_FIELD_NAME_NAME:
|
|
return query.InstanceColumnName
|
|
case instance.FieldName_FIELD_NAME_CREATION_DATE:
|
|
return query.InstanceColumnCreationDate
|
|
case instance.FieldName_FIELD_NAME_UNSPECIFIED:
|
|
fallthrough
|
|
default:
|
|
return query.Column{}
|
|
}
|
|
}
|
|
|
|
func instanceQueriesToModel(queries []*instance.Query) (_ []query.SearchQuery, err error) {
|
|
q := []query.SearchQuery{}
|
|
for _, query := range queries {
|
|
model, err := instanceQueryToModel(query)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
q = append(q, model)
|
|
}
|
|
return q, nil
|
|
}
|
|
|
|
func instanceQueryToModel(searchQuery *instance.Query) (query.SearchQuery, error) {
|
|
switch q := searchQuery.GetQuery().(type) {
|
|
case *instance.Query_IdQuery:
|
|
return query.NewInstanceIDsListSearchQuery(q.IdQuery.GetIds()...)
|
|
case *instance.Query_DomainQuery:
|
|
return query.NewInstanceDomainsListSearchQuery(q.DomainQuery.GetDomains()...)
|
|
default:
|
|
return nil, zerrors.ThrowInvalidArgument(nil, "INST-3m0se", "List.Query.Invalid")
|
|
}
|
|
}
|
|
|
|
func ListCustomDomainsRequestToModel(req *instance.ListCustomDomainsRequest, defaults systemdefaults.SystemDefaults) (*query.InstanceDomainSearchQueries, error) {
|
|
offset, limit, asc, err := filter.PaginationPbToQuery(defaults, req.GetPagination())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
queries, err := domainQueriesToModel(req.GetQueries())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &query.InstanceDomainSearchQueries{
|
|
SearchRequest: query.SearchRequest{
|
|
Offset: offset,
|
|
Limit: limit,
|
|
Asc: asc,
|
|
SortingColumn: fieldNameToInstanceDomainColumn(req.GetSortingColumn()),
|
|
},
|
|
Queries: queries,
|
|
}, nil
|
|
}
|
|
|
|
func fieldNameToInstanceDomainColumn(fieldName instance.DomainFieldName) query.Column {
|
|
switch fieldName {
|
|
case instance.DomainFieldName_DOMAIN_FIELD_NAME_DOMAIN:
|
|
return query.InstanceDomainDomainCol
|
|
case instance.DomainFieldName_DOMAIN_FIELD_NAME_GENERATED:
|
|
return query.InstanceDomainIsGeneratedCol
|
|
case instance.DomainFieldName_DOMAIN_FIELD_NAME_PRIMARY:
|
|
return query.InstanceDomainIsPrimaryCol
|
|
case instance.DomainFieldName_DOMAIN_FIELD_NAME_CREATION_DATE:
|
|
return query.InstanceDomainCreationDateCol
|
|
case instance.DomainFieldName_DOMAIN_FIELD_NAME_UNSPECIFIED:
|
|
fallthrough
|
|
default:
|
|
return query.Column{}
|
|
}
|
|
}
|
|
|
|
func domainQueriesToModel(queries []*instance.DomainSearchQuery) (_ []query.SearchQuery, err error) {
|
|
q := make([]query.SearchQuery, len(queries))
|
|
for i, query := range queries {
|
|
q[i], err = domainQueryToModel(query)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return q, nil
|
|
}
|
|
|
|
func domainQueryToModel(searchQuery *instance.DomainSearchQuery) (query.SearchQuery, error) {
|
|
switch q := searchQuery.GetQuery().(type) {
|
|
case *instance.DomainSearchQuery_DomainQuery:
|
|
return query.NewInstanceDomainDomainSearchQuery(object.TextMethodToQuery(q.DomainQuery.GetMethod()), q.DomainQuery.GetDomain())
|
|
case *instance.DomainSearchQuery_GeneratedQuery:
|
|
return query.NewInstanceDomainGeneratedSearchQuery(q.GeneratedQuery.GetGenerated())
|
|
case *instance.DomainSearchQuery_PrimaryQuery:
|
|
return query.NewInstanceDomainPrimarySearchQuery(q.PrimaryQuery.GetPrimary())
|
|
default:
|
|
return nil, zerrors.ThrowInvalidArgument(nil, "INST-Ags42", "List.Query.Invalid")
|
|
}
|
|
}
|
|
|
|
func ListTrustedDomainsRequestToModel(req *instance.ListTrustedDomainsRequest, defaults systemdefaults.SystemDefaults) (*query.InstanceTrustedDomainSearchQueries, error) {
|
|
offset, limit, asc, err := filter.PaginationPbToQuery(defaults, req.GetPagination())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
queries, err := trustedDomainQueriesToModel(req.GetQueries())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &query.InstanceTrustedDomainSearchQueries{
|
|
SearchRequest: query.SearchRequest{
|
|
Offset: offset,
|
|
Limit: limit,
|
|
Asc: asc,
|
|
SortingColumn: fieldNameToInstanceTrustedDomainColumn(req.GetSortingColumn()),
|
|
},
|
|
Queries: queries,
|
|
}, nil
|
|
}
|
|
|
|
func trustedDomainQueriesToModel(queries []*instance.TrustedDomainSearchQuery) (_ []query.SearchQuery, err error) {
|
|
q := make([]query.SearchQuery, len(queries))
|
|
for i, query := range queries {
|
|
q[i], err = trustedDomainQueryToModel(query)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return q, nil
|
|
}
|
|
|
|
func trustedDomainQueryToModel(searchQuery *instance.TrustedDomainSearchQuery) (query.SearchQuery, error) {
|
|
switch q := searchQuery.GetQuery().(type) {
|
|
case *instance.TrustedDomainSearchQuery_DomainQuery:
|
|
return query.NewInstanceTrustedDomainDomainSearchQuery(object.TextMethodToQuery(q.DomainQuery.GetMethod()), q.DomainQuery.GetDomain())
|
|
default:
|
|
return nil, zerrors.ThrowInvalidArgument(nil, "INST-Ags42", "List.Query.Invalid")
|
|
}
|
|
}
|
|
|
|
func trustedDomainsToPb(domains []*query.InstanceTrustedDomain) []*instance.TrustedDomain {
|
|
d := make([]*instance.TrustedDomain, len(domains))
|
|
for i, domain := range domains {
|
|
d[i] = trustedDomainToPb(domain)
|
|
}
|
|
return d
|
|
}
|
|
|
|
func trustedDomainToPb(d *query.InstanceTrustedDomain) *instance.TrustedDomain {
|
|
return &instance.TrustedDomain{
|
|
Domain: d.Domain,
|
|
InstanceId: d.InstanceID,
|
|
CreationDate: timestamppb.New(d.CreationDate),
|
|
}
|
|
}
|
|
|
|
func fieldNameToInstanceTrustedDomainColumn(fieldName instance.TrustedDomainFieldName) query.Column {
|
|
switch fieldName {
|
|
case instance.TrustedDomainFieldName_TRUSTED_DOMAIN_FIELD_NAME_DOMAIN:
|
|
return query.InstanceTrustedDomainDomainCol
|
|
case instance.TrustedDomainFieldName_TRUSTED_DOMAIN_FIELD_NAME_CREATION_DATE:
|
|
return query.InstanceTrustedDomainCreationDateCol
|
|
case instance.TrustedDomainFieldName_TRUSTED_DOMAIN_FIELD_NAME_UNSPECIFIED:
|
|
fallthrough
|
|
default:
|
|
return query.Column{}
|
|
}
|
|
}
|