org.eclipse.edc.iam.did.web.WebDidExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of identity-did-web Show documentation
edc :: identity-did-web
The newest version!
/*
 *  Copyright (c) 2021 Microsoft Corporation
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Microsoft Corporation - initial API and implementation
 *
 */

package org.eclipse.edc.iam.did.web;

import org.eclipse.edc.http.spi.EdcHttpClient;
import org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry;
import org.eclipse.edc.iam.did.web.resolution.WebDidResolver;
import org.eclipse.edc.runtime.metamodel.annotation.Extension;
import org.eclipse.edc.runtime.metamodel.annotation.Inject;
import org.eclipse.edc.runtime.metamodel.annotation.Setting;
import org.eclipse.edc.spi.system.ServiceExtension;
import org.eclipse.edc.spi.system.ServiceExtensionContext;
import org.eclipse.edc.spi.types.TypeManager;
import org.eclipse.edc.util.string.StringUtils;


/**
 * Initializes support for resolving Web DIDs.
 */
@Extension(value = WebDidExtension.NAME)
public class WebDidExtension implements ServiceExtension {
    public static final String NAME = "Web DID";
    /**
     * If set, the resolver will use the endpoint to resolve DIDs using DNS over HTTPS.
     */
    @Setting
    public static final String DNS_OVER_HTTPS = "edc.webdid.doh.url";
    /**
     * Set to {@code false} to create DID URLs with {@code http} instead of {@code https} scheme.
     * Defaults to {@code true}.
     * 
     * This setting can be used by EDC downstream projects, e.g. for testing with docker compose
     */
    @Setting
    private static final String USE_HTTPS_SCHEME = "edc.iam.did.web.use.https";
    @Inject
    private DidResolverRegistry resolverRegistry;

    @Inject
    private EdcHttpClient httpClient;

    @Inject
    private TypeManager typeManager;

    @Override
    public String name() {
        return NAME;
    }

    @Override
    public void initialize(ServiceExtensionContext context) {
        var mapper = typeManager.getMapper();
        var monitor = context.getMonitor();
        var useHttpsScheme = context.getSetting(USE_HTTPS_SCHEME, true);

        var httpClient = getHttpClient(context);

        var resolver = new WebDidResolver(httpClient, useHttpsScheme, mapper, monitor);

        resolverRegistry.register(resolver);
    }

    private EdcHttpClient getHttpClient(ServiceExtensionContext context) {
        var dnsServer = context.getSetting(DNS_OVER_HTTPS, null);

        if (StringUtils.isNullOrEmpty(dnsServer)) {
            return httpClient;
        } else {
            // use DNS over HTTPS for name lookups
            return httpClient.withDns(dnsServer);
        }
    }

}