lib/src/main/java/io/v/v23/security/BlessingRoots.java

// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package io.v.v23.security;

import com.google.common.collect.Multimap;
import io.v.v23.verror.VException;

import java.security.interfaces.ECPublicKey;

/**
 * The set of authoritative public keys for roots of blessings.
 * <p>
 * See also: <a href="https://github.com/vanadium/docs/blob/master/glossary.md#blessing-root">https://github.com/vanadium/docs/blob/master/glossary.md#blessing-root</a>.
 */
public interface BlessingRoots {
    /**
     * Marks {@code root} as an authoritative key for blessings that match {@code pattern}.
     *
     * Multiple keys can be added for the same pattern, in which case all those keys are considered
     * authoritative for blessings that match the pattern.
     *
     * @param  root            root that is deemed an authoritiative key for the provided pattern
     * @param  pattern         pattern for which we're assigning the authoratitative key
     * @throws VException      if there was an error assigning the root
     */
    void add(ECPublicKey root, BlessingPattern pattern) throws VException;

    /**
     * Returns {@code null} iff the provided root is recognized as an authority on a pattern
     * that is matched by the blessing.
     *
     * @param  root            the root key we're checking for authority
     * @param  blessing        the blessing we're checking against the root
     * @throws VException      if the provided root is not recognized as an authority for the
     *                         provided blessing
     */
    void recognized(ECPublicKey root, String blessing) throws VException;

    /**
     * Returns the set of recognized roots as a map from {@link BlessingPattern} to the set
     * of authoritative keys for that pattern.
     *
     * @throws VException      if there was an error preparing the dump
     */
    Multimap<BlessingPattern, ECPublicKey> dump() throws VException;

    /**
     * Return a human-readable string description of the roots.  This description is detailed and
     * lists out the contents of the roots.  Use {@link Object#toString} method for a more
     * succinct description.
     *
     * @return human-readable string description of the roots
     */
    String debugString();
}