commonMain.io.realm.kotlin.mongodb.HttpLogObfuscator.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of library-sync Show documentation

Sync Library code for Realm Kotlin. This artifact is not supposed to be consumed directly, but through 'io.realm.kotlin:gradle-plugin:1.6.2' instead.

There is a newer version: 2.3.0

Show newest version

/*
 * Copyright 2023 Realm Inc.
 *
 * 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.realm.kotlin.mongodb

/**
 * The `HttpLogObfuscator` keeps sensitive information from being displayed in output traces.
 */
public interface HttpLogObfuscator {
    /**
     * Obfuscates a log entry depending on whether the data being sent contains information deemed
     * sensitive. The following information is considered sensitive data:
     * - passwords
     * - tokens of any kind - see [Credentials] for more information
     * - custom function arguments - see [Functions] for more information
     *
     * @param input the original log entry to be obfuscated.
     * @return the log entry to be shown
     */
    public fun obfuscate(input: String): String
}