keywhiz.api.model.SanitizedSecret.java Source code

Introduction

Here is the source code for keywhiz.api.model.SanitizedSecret.java

Source

/*
 * Copyright (C) 2015 Square, 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 keywhiz.api.model;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
import keywhiz.api.ApiDate;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Strings.nullToEmpty;

/**
 * {@link Secret} object, but without the secret content.
 */
@AutoValue
public abstract class SanitizedSecret {
    @JsonCreator
    public static SanitizedSecret of(@JsonProperty("id") long id, @JsonProperty("name") String name,
            @JsonProperty("description") @Nullable String description, @JsonProperty("checksum") String checksum,
            @JsonProperty("createdAt") ApiDate createdAt, @JsonProperty("createdBy") @Nullable String createdBy,
            @JsonProperty("updatedAt") ApiDate updatedAt, @JsonProperty("updatedBy") @Nullable String updatedBy,
            @JsonProperty("metadata") @Nullable Map<String, String> metadata,
            @JsonProperty("type") @Nullable String type,
            @JsonProperty("generationOptions") @Nullable Map<String, String> generationOptions,
            @JsonProperty("expiry") long expiry, @JsonProperty("version") @Nullable Long version) {
        ImmutableMap<String, String> meta = (metadata == null) ? ImmutableMap.of() : ImmutableMap.copyOf(metadata);
        ImmutableMap<String, String> genOptions = (generationOptions == null) ? ImmutableMap.of()
                : ImmutableMap.copyOf(generationOptions);
        return new AutoValue_SanitizedSecret(id, name, nullToEmpty(description), checksum, createdAt,
                nullToEmpty(createdBy), updatedAt, nullToEmpty(updatedBy), meta, Optional.ofNullable(type),
                genOptions, expiry, Optional.ofNullable(version));
    }

    public static SanitizedSecret of(long id, String name) {
        return of(id, name, null, "", new ApiDate(0), null, new ApiDate(0), null, null, null, null, 0, null);
    }

    public static SanitizedSecret fromSecretSeriesAndContent(SecretSeriesAndContent seriesAndContent) {
        SecretSeries series = seriesAndContent.series();
        SecretContent content = seriesAndContent.content();
        return SanitizedSecret.of(series.id(), series.name(), series.description(), content.hmac(),
                series.createdAt(), series.createdBy(), series.updatedAt(), series.updatedBy(), content.metadata(),
                series.type().orElse(null), series.generationOptions(), content.expiry(), content.id());
    }

    /**
     * Build a matching representation of a secret, but without sensitive content.
     *
     * @param secret secret model to build from
     * @return content of secret model, but without sensitive content
     */
    public static SanitizedSecret fromSecret(Secret secret) {
        checkNotNull(secret);
        return SanitizedSecret.of(secret.getId(), secret.getName(), secret.getDescription(), secret.getChecksum(),
                secret.getCreatedAt(), secret.getCreatedBy(), secret.getUpdatedAt(), secret.getUpdatedBy(),
                secret.getMetadata(), secret.getType().orElse(null), secret.getGenerationOptions(),
                secret.getExpiry(), secret.getVersion().orElse(null));
    }

    @JsonProperty
    public abstract long id();

    @JsonProperty
    public abstract String name();

    @JsonProperty
    public abstract String description();

    @JsonProperty
    public abstract String checksum();

    @JsonProperty
    public abstract ApiDate createdAt();

    @JsonProperty
    public abstract String createdBy();

    @JsonProperty
    public abstract ApiDate updatedAt();

    @JsonProperty
    public abstract String updatedBy();

    @JsonProperty
    public abstract ImmutableMap<String, String> metadata();

    @JsonProperty
    public abstract Optional<String> type();

    @JsonProperty
    public abstract ImmutableMap<String, String> generationOptions();

    @JsonProperty
    public abstract long expiry();

    @JsonProperty
    public abstract Optional<Long> version();

    /** @return Name to serialize for clients. */
    public static String displayName(SanitizedSecret sanitizedSecret) {
        return sanitizedSecret.name();
    }
}