Skip to content

chore: change sql parameter for custom roles to be a (name,org) tuple #13480

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

Merged
merged 7 commits into from
Jun 6, 2024
Merged

chore: change sql parameter for custom roles to be a (name,org) tuple #13480

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8e98cea
chore: sql parameter to custom roles to be a (name,org) tuple
Emyrk Jun 5, 2024
4356f53
WIP
Emyrk Jun 5, 2024
7f37232
got it working
Emyrk Jun 5, 2024
a305e70
revert logging
Emyrk Jun 5, 2024
8da3601
fixups
Emyrk Jun 5, 2024
dc7fe77
fixup null
Emyrk Jun 5, 2024
a1a42b8
fixup sqlc
Emyrk Jun 6, 2024
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
Prev Previous commit
Next Next commit
fixup null
  • Loading branch information
@Emyrk
Emyrk committed Jun 5, 2024
commit dc7fe77ce060bf890b3d1b4a128c1df24515dc4e
2 changes: 1 addition & 1 deletion coderd/database/models.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion coderd/database/querier.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions coderd/database/queries.sql.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion coderd/database/queries/roles.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ WHERE
-- To do this manually in SQL, you can construct an array and cast it:
-- cast(ARRAY[('customrole','ece79dac-926e-44ca-9790-2ff7c5eb6e0c')] AS name_organization_pair[])
AND CASE WHEN array_length(@lookup_roles :: name_organization_pair[], 1) > 0 THEN
(name, organization_id) = ANY (@lookup_roles::name_organization_pair[])
-- Using 'coalesce' to avoid troubles with null literals being an empty string.
(name, coalesce(organization_id, '00000000-0000-0000-0000-000000000000' ::uuid)) = ANY (@lookup_roles::name_organization_pair[])
Comment on lines +12 to +13
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can bring NULL back, but for the life of me I could not get it to work. I think it has to do with my understanding of representing NULL as a literal

ELSE true
END
-- This allows fetching all roles, or just site wide roles
Expand Down
8 changes: 2 additions & 6 deletions coderd/database/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,13 @@ func (*NameOrganizationPair) Scan(_ interface{}) error {
// shell.
//
// SELECT ('customrole'::text,'ece79dac-926e-44ca-9790-2ff7c5eb6e0c'::uuid);
// To see 'null' option
// SELECT ('customrole',null);
// To see 'null' option. Using the nil uuid as null to avoid empty string literals for null.
// SELECT ('customrole',00000000-0000-0000-0000-000000000000);
//
// This value is usually used as an array, NameOrganizationPair[]. You can see
// what that literal is as well, with proper quoting.
//
// SELECT ARRAY[('customrole'::text,'ece79dac-926e-44ca-9790-2ff7c5eb6e0c'::uuid)];
func (a NameOrganizationPair) Value() (driver.Value, error) {
if a.OrganizationID == uuid.Nil {
return fmt.Sprintf(`('%s',)`, a.Name), nil
}

return fmt.Sprintf(`(%s,%s)`, a.Name, a.OrganizationID.String()), nil
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the name here probably want to use https://pkg.go.dev/github.com/lib/pq#QuoteLiteral unless I'm misunderstanding. This seems like direct sql injection.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It cannot be quoted, I was trying that before. This is a parameter argument still, so it will replace ?#.

I had considered a sql injection, but can a sql injection happen at a parameter substitution?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, good point actually. This is fine, sry

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just tried to send in some invalid sql with -- and ; as the names, and the query still works.

The defaultValueConverter which implments this function for all primitive types just does the literal string value without quotes or escapes: https://github.com/golang/go/blob/master/src/database/sql/driver/types.go#L291-L293

That is the function behavior I am overriding. 👍

}
Loading