org.hyperledger.aries.api.jsonld.SignRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aries-client-python Show documentation

Aries Cloud Agent - Python: Java client implementation

There is a newer version: 0.10.0

/*
 * Copyright (c) 2020-2021 - for information on the respective copyright owner
 * see the NOTICE file and/or the repository at
 * https://github.com/hyperledger-labs/acapy-java-client
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.aries.api.jsonld;

import com.google.gson.Gson;
import com.google.gson.JsonObject;
import com.google.gson.annotations.SerializedName;
import lombok.Builder;
import lombok.Data;
import lombok.NonNull;
import org.hyperledger.aries.api.jsonld.SignRequest.SignDocument.Options;
import org.hyperledger.aries.config.GsonConfig;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Use the SignRequest.from() method to easily construct a new sign request.
 * {@code
 * SignRequest signRequest = SignRequest.from(
 *     verkey,
 *     verifiablePresentation,
 *     Options.builderWithDefaults()
 *         .verificationMethod("did:key:" + verkey) // self signed
 *         .build());
 * }
 */
@Data @Builder
public final class SignRequest {

    @NonNull @Nonnull
    private String verkey;

    @NonNull @Nonnull
    private SignDocument doc;

    @Data @Builder
    public static final class SignDocument {

        @NonNull @Nonnull
        private JsonObject credential; // either VC or VP

        @NonNull @Nonnull
        private Options options;

        @Data @Builder
        public static final class Options {
            @Nullable
            private String creator;
            @Nullable
            @SerializedName("verificationMethod")
            private String verificationMethod;
            @Nullable
            @SerializedName("proofPurpose")
            private String proofPurpose;

            private String type;

            public static class OptionsBuilder {} // java doc plugin cannot handle lombok

            public static OptionsBuilder builderWithDefaults() {
                return Options
                        .builder()
                        .type("Ed25519Signature2018")
                        .proofPurpose("authentication"); // VP = authentication, VC = assertionMethod
            }
        }
    }

    public static SignRequest from(String verkey, Object t, Options options) {
        if (t instanceof VerifiableCredential || t instanceof VerifiablePresentation) {
            Gson gson = GsonConfig.defaultConfig();
            return SignRequest.builder()
                    .verkey(verkey)
                    .doc(SignDocument.builder()
                            .credential(gson.toJsonTree(t).getAsJsonObject())
                            .options(options)
                            .build())
                    .build();
        }
        throw new IllegalStateException("Expecting either VerifiableCredential or VerifiablePresentation");
    }
}