com.google.crypto.tink.internal.MonitoringUtil Maven / Gradle / Ivy

// Copyright 2022 Google LLC
//
// 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 com.google.crypto.tink.internal;

import com.google.crypto.tink.KeyStatus;
import com.google.crypto.tink.PrimitiveSet;
import com.google.crypto.tink.monitoring.MonitoringClient;
import com.google.crypto.tink.monitoring.MonitoringKeysetInfo;
import com.google.crypto.tink.proto.KeyStatusType;
import java.security.GeneralSecurityException;
import java.util.List;
import javax.annotation.Nullable;

/** Some util functions needed to add monitoring to the Primitives. */
public final class MonitoringUtil {

  private static class DoNothingLogger implements MonitoringClient.Logger {
    @Override
    public void log(int keyId, long numBytesAsInput) {}

    @Override
    public void logFailure() {}
  }

  public static final MonitoringClient.Logger DO_NOTHING_LOGGER = new DoNothingLogger();

  private static KeyStatus parseStatus(KeyStatusType in) {
    switch (in) {
      case ENABLED:
        return KeyStatus.ENABLED;
      case DISABLED:
        return KeyStatus.DISABLED;
      case DESTROYED:
        return KeyStatus.DESTROYED;
      default:
        throw new IllegalStateException("Unknown key status");
    }
  }

  private static final String TYPE_URL_PREFIX = "type.googleapis.com/google.crypto.";

  private static String parseKeyTypeUrl(String keyTypeUrl) {
    if (!keyTypeUrl.startsWith(TYPE_URL_PREFIX)) {
      return keyTypeUrl;
    }
    return keyTypeUrl.substring(TYPE_URL_PREFIX.length());
  }

  public static  MonitoringKeysetInfo getMonitoringKeysetInfo(PrimitiveSet
 primitiveSet) {
    MonitoringKeysetInfo.Builder builder = MonitoringKeysetInfo.newBuilder();
    builder.setAnnotations(primitiveSet.getAnnotations());
    for (List> entries : primitiveSet.getAll()) {
      for (PrimitiveSet.Entry
 entry : entries) {
        builder.addEntry(
            parseStatus(entry.getStatus()),
            entry.getKeyId(),
            parseKeyTypeUrl(entry.getKeyType()),
            entry.getOutputPrefixType().name());
      }
    }
    @Nullable PrimitiveSet.Entry primary = primitiveSet.getPrimary();
    if (primary != null) {
      builder.setPrimaryKeyId(primitiveSet.getPrimary().getKeyId());
    }
    try {
      return builder.build();
    } catch (GeneralSecurityException e) {
      // This shouldn't happen, since for PrimitiveSets, the primary's key id is always in the
      // entries list.
      throw new IllegalStateException(e);
    }
  }

  private MonitoringUtil() {}
}