Skip to content

fix(user): never serialise password digests or SSO tokens #341

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
stakach merged 1 commit into from
Nov 12, 2026
Merged

fix(user): never serialise password digests or SSO tokens #341

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
29 changes: 29 additions & 0 deletions spec/user_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,7 @@ module PlaceOS::Model
end

views = {
"raw" => ->(u : User) { u.to_json },
"public" => ->(u : User) { u.to_public_json },
"public_struct" => ->(u : User) { u.to_public_struct.to_json },
"public_meta" => ->(u : User) { u.to_public_metadata_json },
Expand Down Expand Up @@ -351,6 +352,34 @@ module PlaceOS::Model
end
end

it "never serialises a plain text password set before saving" do
user = Generator.user
user.password = "uns4ved-p@ssw0rd"

user.to_json.should_not contain("uns4ved-p@ssw0rd")
end

# Changefeeds rebuild models from the database's JSON, so secrets must
# still be read even though they are never written
it "still reads secrets from trusted JSON" do
user = User.from_trusted_json({
name: "Changefeed User",
email: "changefeed@example.com",
authority_id: "authority-12345",
password_digest: "$2a$11$digest",
access_token: "feed-access",
refresh_token: "feed-refresh",
expires_at: 1234_i64,
expires: true,
}.to_json)

user.password_digest.should eq "$2a$11$digest"
user.access_token.should eq "feed-access"
user.refresh_token.should eq "feed-refresh"
user.expires_at.should eq 1234_i64
user.expires.should be_true
end

{"public", "public_struct", "public_meta", "public_meta_st"}.each do |view|
it "hides admin only fields from the #{view} view" do
user = secret_user.call
Expand Down
13 changes: 7 additions & 6 deletions src/placeos-models/user.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,20 @@ module PlaceOS::Model
attribute department : String?, sanitize: :text
attribute preferred_language : String?

attribute password_digest : String?, mass_assignment: false
# Secrets are never serialised (they're still read, e.g. by changefeeds)
attribute password_digest : String?, mass_assignment: false, ignore_serialize: true
attribute email_digest : String?, mass_assignment: false
attribute card_number : String?, mass_assignment: false

attribute deleted : Bool = false, mass_assignment: false
attribute groups : Array(String) = [] of String, mass_assignment: false

attribute access_token : String?, mass_assignment: false
attribute refresh_token : String?, mass_assignment: false
attribute expires_at : Int64?, mass_assignment: false
attribute expires : Bool = false, mass_assignment: false
attribute access_token : String?, mass_assignment: false, ignore_serialize: true
attribute refresh_token : String?, mass_assignment: false, ignore_serialize: true
attribute expires_at : Int64?, mass_assignment: false, ignore_serialize: true
attribute expires : Bool = false, mass_assignment: false, ignore_serialize: true

attribute password : String?
attribute password : String?, ignore_serialize: true

attribute sys_admin : Bool = false, mass_assignment: false
attribute support : Bool = false, mass_assignment: false
Expand Down
Loading