001/* 002 * Copyright 2026 Revetware LLC. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016package com.revetsec.password; 017 018import org.jspecify.annotations.NonNull; 019 020import javax.annotation.concurrent.Immutable; 021 022import static java.util.Objects.requireNonNull; 023 024/** A generated password verifier. Treat its stored form as sensitive credential data even though 025 * it contains no plaintext password. Logging and {@link #toString()} redact it. 026 * @since 1.0.0 */ 027@Immutable 028public final class PasswordHash { 029 private final @NonNull String storedForm; 030 031 PasswordHash(@NonNull String storedForm) { this.storedForm = requireNonNull(storedForm); } 032 033 /** Returns the complete durable representation, including any non-secret pepper key ID. 034 * Store it atomically with the account's credential version. Access to this value is deliberate. 035 * @return durable stored form 036 * @since 1.0.0 */ 037 public @NonNull String getStoredForm() { return storedForm; } 038 039 /** @return a fixed redacted description 040 * @since 1.0.0 */ 041 @Override public @NonNull String toString() { return "PasswordHash{<redacted>}"; } 042}