io.streamthoughts.jikkou.rest.security.password.PasswordEncoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jikkou-api-server Show documentation

REST API interface for Jikkou

There is a newer version: 0.33.3

/*
 * Copyright 2023 The original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.streamthoughts.jikkou.rest.security.password;

import io.micronaut.core.annotation.NonNull;

/**
 * Service interface for encoding passwords.
 */
public interface PasswordEncoder {

    /**
     * Verify the encoded password obtained from storage matches the submitted raw
     * password after it too is encoded. Returns true if the passwords match, false if
     * they do not. The stored password itself is never decoded.
     *
     * @param rawPassword the raw password to encode and match
     * @param encodedPassword the encoded password from storage to compare with
     * @return true if the raw password, after encoding, matches the encoded password from storage
     */
    boolean matches(
            @NonNull String rawPassword,
            @NonNull String encodedPassword);

    /**
     * Encode the raw password.
     *
     * @param rawPassword   the raw password to encode.
     * @return              the encoded password.
     */
    String encode(@NonNull String rawPassword);
}