使用OCI Java SDK为自定义REST请求生成认证签名-java教程-PHP中文网

使用oci java sdk为自定义rest请求生成认证签名

本文详细介绍了如何利用Oracle OCI Java SDK的`DefaultRequestSigner`功能，为自定义的REST API请求生成必要的`Authorization`和`Date`头。通过这种方式，开发者可以在不直接使用SDK高层客户端的情况下，安全地对OCI服务发起认证请求，从而实现更灵活的集成和控制。

在与Oracle Cloud Infrastructure (OCI) 服务进行交互时，通常推荐使用官方提供的Java SDK客户端，它们封装了复杂的认证、请求构建和响应处理逻辑。然而，在某些特定场景下，例如当SDK客户端不支持某个特定的API操作、需要集成现有的HTTP客户端库，或者需要对请求的细节有更精细的控制时，开发者可能希望直接构造并发送HTTP请求。在这种情况下，核心挑战在于如何正确地对这些自定义请求进行认证，即生成符合OCI安全规范的Authorization和Date头部。

OCI的认证机制是基于签名的，而不是简单的Bearer Token。这意味着Authorization头的内容是一个复杂的签名字符串，它包含了请求的多个要素（如HTTP方法、URI路径、请求体哈希等）以及用户的私钥信息。手动构建这个签名是复杂且容易出错的。幸运的是，OCI Java SDK提供了一个名为DefaultRequestSigner的实用工具，它能够帮助我们自动完成这一过程。

理解OCI认证与DefaultRequestSigner

OCI的签名认证要求每个请求都包含一个Date头（表示请求发送时间）和一个Authorization头。Authorization头包含了请求的签名信息，证明请求是由拥有对应私钥的身份发出的，并且请求内容在传输过程中未被篡改。

立即学习“Java免费学习笔记（深入）”；

DefaultRequestSigner是OCI Java SDK中用于生成这些认证头部的核心组件。它接收一个代表HTTP请求的内部SdkRequest对象，然后根据配置的认证详情（如租户OCID、用户OCID、指纹、私钥等），计算出正确的Authorization和Date头，并将其添加到SdkRequest中。随后，开发者可以从这个已签名的SdkRequest中提取这些头部信息，并将其应用到自己的HTTP客户端发出的请求中。

使用DefaultRequestSigner生成认证头部的步骤

以下是使用DefaultRequestSigner为自定义REST请求生成认证头部的详细步骤：

NameGPT名称生成器

免费AI公司名称生成器，AI在线生成企业名称，注册公司名称起名大全。

查看详情

1. 配置认证详情提供者

首先，你需要一个AuthenticationDetailsProvider实例，它负责提供进行认证所需的凭据。最常见的方式是使用配置文件或实例主体（Instance Principal）认证。

通过配置文件认证： 这要求你的系统上存在一个OCI配置文件（通常位于~/.oci/config），其中包含你的用户凭据。

import com.oracle.bmc.auth.AuthenticationDetailsProvider;
import com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider;

// 假设配置文件路径为 ~/.oci/config，使用 DEFAULT 配置项
AuthenticationDetailsProvider provider = new ConfigFileAuthenticationDetailsProvider("~/.oci/config", "DEFAULT");

登录后复制

通过实例主体认证（适用于在OCI计算实例上运行的应用）：

import com.oracle.bmc.auth.AuthenticationDetailsProvider;
import com.oracle.bmc.auth.InstancePrincipalsAuthenticationDetailsProvider;

AuthenticationDetailsProvider provider = InstancePrincipalsAuthenticationDetailsProvider.builder().build();

登录后复制

2. 初始化DefaultRequestSigner

使用上一步创建的AuthenticationDetailsProvider来初始化DefaultRequestSigner。

import com.oracle.bmc.http.signing.DefaultRequestSigner;
import com.oracle.bmc.http.signing.RequestSigner;

RequestSigner requestSigner = new DefaultRequestSigner(provider);

登录后复制

3. 构建一个SdkRequest对象

DefaultRequestSigner期望接收一个com.oracle.bmc.http.internal.SdkRequest对象。这个对象用于模拟你希望发送的HTTP请求的各个方面，包括URI、HTTP方法、查询参数和请求体。

import com.oracle.bmc.http.internal.SdkRequest;
import com.oracle.bmc.http.internal.SdkAutoCloseable;
import com.oracle.bmc.model.BmcException;
import com.oracle.bmc.requests.CreateBucketRequest; // 示例：以创建桶请求为例
import com.oracle.bmc.objectstorage.requests.GetNamespaceRequest; // 示例：以获取命名空间请求为例
import com.oracle.bmc.objectstorage.model.CreateBucketDetails;

import java.net.URI;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

// 示例：模拟一个获取对象存储命名空间的GET请求
// SdkRequest通常通过SDK客户端的请求对象（如GetNamespaceRequest）的to  Http Request()方法获得
// 但这里为了演示，我们可以手动构建一个简单的 SdkRequest
// 注意：手动构建 SdkRequest 比较复杂，通常建议从现有的 SDK 请求对象转换。
// 对于完全自定义的请求，需要确保 SdkRequest 的所有相关属性都正确设置。

// 假设我们要模拟一个 GET /n/{namespace} 的请求
URI targetUri = URI.create("https://objectstorage.us-ashburn-1.oraclecloud.com/n/your_namespace"); // 替换为你的OCI区域和命名空间
String httpMethod = "GET";

// SdkRequest 的具体实现通常是抽象的，但我们可以创建其内部的默认实现或者使用一个简单模拟
// 这是一个简化示例，实际使用中可能需要更复杂的构建
SdkRequest sdkRequest = new SdkRequest() {
    private final Map<String, String> headers = new HashMap<>();
    private final Map<String, java.util.List<String>> queryParameters = new HashMap<>();
    private byte[] body = null;

    @Override
    public URI getUri() {
        return targetUri;
    }

    @Override
    public String getHttpMethod() {
        return httpMethod;
    }

    @Override
    public Map<String, String> getHeaders() {
        return headers;
    }

    @Override
    public Map<String, java.util.List<String>> getQueryParameters() {
        return queryParameters;
    }

    @Override
    public java.io.InputStream getBody() {
        if (body == null) {
            return null;
        }
        return new java.io.ByteArrayInputStream(body);
    }

    @Override
    public long getContentLength() {
        return body == null ? 0 : body.length;
    }

    @Override
    public SdkRequest copy() {
        // 简单实现，实际可能需要深拷贝
        return this;
    }

    @Override
    public <T extends SdkRequest> T setHeaders(Map<String, String> headers) {
        this.headers.clear();
        this.headers.putAll(headers);
        return (T) this;
    }

    @Override
    public <T extends SdkRequest> T setQueryParameters(Map<String, java.util.List<String>> queryParameters) {
        this.queryParameters.clear();
        this.queryParameters.putAll(queryParameters);
        return (T) this;
    }

    @Override
    public <T extends SdkRequest> T setBody(java.io.InputStream body) {
        try {
            if (body != null) {
                this.body = body.readAllBytes();
            } else {
                this.body = null;
            }
        } catch (java.io.IOException e) {
            throw new RuntimeException("Failed to read body input stream", e);
        }
        return (T) this;
    }

    @Override
    public <T extends SdkRequest> T setBody(byte[] body) {
        this.body = body;
        return (T) this;
    }

    @Override
    public void close() throws Exception {
        // No-op for this simple example
    }
};

// 如果是 POST/PUT 请求，需要设置请求体
// String jsonBody = "{\"name\": \"my-new-bucket\", \"compartmentId\": \"ocid1.compartment.oc1..aaaa...\"}";
// sdkRequest.setBody(jsonBody.getBytes(java.nio.charset.StandardCharsets.UTF_8));
// sdkRequest.getHeaders().put("Content-Type", "application/json");

登录后复制

4. 对SdkRequest进行签名

调用requestSigner.signRequest(sdkRequest)方法。这个方法会修改传入的sdkRequest对象，为其添加Authorization和Date头。

try {
    requestSigner.signRequest(sdkRequest);
} catch (BmcException e) {
    System.err.println("Error signing request: " + e.getMessage());
    // 处理签名错误
    return;
}

登录后复制

5. 提取并使用生成的头部

签名完成后，你可以从sdkRequest中提取Authorization和Date头，并将其应用到你的自定义HTTP客户端（如java.net.http.HttpClient、Apache HttpClient、OkHttp等）发出的请求中。

// 提取签名后的头部
String authorizationHeader = sdkRequest.getHeaders().get("Authorization");
String dateHeader = sdkRequest.getHeaders().get("Date");

if (authorizationHeader != null && dateHeader != null) {
    System.out.println("Generated Authorization Header: " + authorizationHeader);
    System.out.println("Generated Date Header: " + dateHeader);

    // 示例：使用 java.net.http.HttpClient 发送请求
    try {
        java.net.http.HttpClient httpClient = java.net.http.HttpClient.newHttpClient();
        java.net.http.HttpRequest.Builder httpRequestBuilder = java.net.http.HttpRequest.newBuilder()
                .uri(targetUri)
                .header("Authorization", authorizationHeader)
                .header("Date", dateHeader);

        if (httpMethod.equalsIgnoreCase("GET")) {
            httpRequestBuilder.GET();
        } else if (httpMethod.equalsIgnoreCase("POST")) {
            // 对于 POST 请求，需要设置请求体和 Content-Type
            // httpRequestBuilder.POST(java.net.http.HttpRequest.BodyPublishers.ofByteArray(sdkRequest.getBody().readAllBytes()))
            //                .header("Content-Type", sdkRequest.getHeaders().get("Content-Type"));
            System.out.println("For POST/PUT, remember to set BodyPublisher and Content-Type header.");
        }
        // ... 其他HTTP方法

        java.net.http.HttpRequest finalHttpRequest = httpRequestBuilder.build();

        // 打印最终请求的头部，确认签名已添加
        System.out.println("\nFinal HTTP Request Headers:");
        finalHttpRequest.headers().map().forEach((name, values) -> {
            System.out.println("  " + name + ": " + String.join(", ", values));
        });

        // 发送请求 (此步需要真实的 OCI 服务端点和权限)
        // java.net.http.HttpResponse<String> response = httpClient.send(finalHttpRequest, java.net.http.HttpResponse.BodyHandlers.ofString());
        // System.out.println("Response Status Code: " + response.statusCode());
        // System.out.println("Response Body: " + response.body());

    } catch (Exception e) {
        System.err.println("Error sending HTTP request: " + e.getMessage());
    }
} else {
    System.err.println("Failed to generate Authorization or Date headers.");
}

登录后复制

完整示例代码

import com.oracle.bmc.auth.AuthenticationDetailsProvider;
import com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider;
import com.oracle.bmc.http.internal.SdkRequest;
import com.oracle.bmc.http.signing.DefaultRequestSigner;
import com.oracle.bmc.http.signing.RequestSigner;
import com.oracle.bmc.model.BmcException;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class OciCustomRestSigner {

    public static void main(String[] args) {
        // 1. 配置认证详情提供者
        AuthenticationDetailsProvider provider;
        try {
            // 假设配置文件路径为 ~/.oci/config，使用 DEFAULT 配置项
            provider = new ConfigFileAuthenticationDetailsProvider("~/.oci/config", "DEFAULT");
            System.out.println("Using ConfigFileAuthenticationDetailsProvider.");
        } catch (IOException e) {
            System.err.println("Failed to load OCI config file: " + e.getMessage());
            System.err.println("Attempting to use InstancePrincipalsAuthenticationDetailsProvider...");
            try {
                provider = com.oracle.bmc.auth.InstancePrincipalsAuthenticationDetailsProvider.builder().build();
                System.out.println("Using InstancePrincipalsAuthenticationDetailsProvider.");
            } catch (Exception ex) {
                System.err.println("Failed to initialize InstancePrincipalsAuthenticationDetailsProvider: " + ex.getMessage());
                System.err.println("Please ensure your OCI config is set up correctly or run this on an OCI instance with Instance Principals enabled.");
                return;
            }
        }

        // 2. 初始化 DefaultRequestSigner
        RequestSigner requestSigner = new DefaultRequestSigner(provider);

        // 3. 构建一个 SdkRequest 对象
        // 示例：模拟一个获取对象存储命名空间的GET请求
        // 替换为你的OCI区域和租户的命名空间
        // 例如：https://objectstorage.us-ashburn-1.oraclecloud.com/n/your_namespace
        URI targetUri = URI.create("https://objectstorage.us-ashburn-1.oraclecloud.com/n/your_namespace");
        String httpMethod = "GET";

        // 创建一个匿名的 SdkRequest 实现
        SdkRequest sdkRequest = new SdkRequest() {
            private final Map<String, String> headers = new HashMap<>();
            private final Map<String, List<String>> queryParameters = new HashMap<>();
            private byte[] body = null;

            @Override
            public URI getUri() {
                return targetUri;
            }

            @Override
            public String getHttpMethod() {
                return httpMethod;
            }

            @Override
            public Map<String, String> getHeaders() {
                return headers;
            }

            @Override
            public Map<String, List<String>> getQueryParameters() {
                return queryParameters;
            }

            @Override
            public InputStream getBody() {
                if (body == null) {
                    return null;
                }
                return new ByteArrayInputStream(body);
            }

            @Override
            public long getContentLength() {
                return body == null ? 0 : body.length;
            }

            @Override
            public SdkRequest copy() {
                // 简单实现，实际可能需要深拷贝
                return this;
            }

            @Override
            public <T extends SdkRequest> T setHeaders(Map<String, String> headers) {
                this.headers.clear();
                this.headers.putAll(headers);
                return (T) this;
            }

            @Override
            public <T extends SdkRequest> T setQueryParameters(Map<String, List<String>> queryParameters) {
                this.queryParameters.clear();
                this.queryParameters.putAll(queryParameters);
                return (T) this;
            }

            @Override
            public <T extends SdkRequest> T setBody(InputStream body) {
                try {
                    if (body != null) {
                        this.body = body.readAllBytes();
                    } else {
                        this.body = null;
                    }
                } catch (IOException e) {
                    throw new RuntimeException("Failed to read body input stream", e);
                }
                return (T) this;
            }

            @Override
            public <T extends SdkRequest> T setBody(byte[] body) {
                this.body = body;
                return (T) this;
            }

            @Override
            public void close() throws Exception {
                // No-op for this simple example
            }
        };

        // 如果是 POST/PUT 请求，需要设置请求体和Content-Type
        // String jsonBody = "{\"name\": \"my-new-bucket\", \"compartmentId\": \"ocid1.compartment.oc1..aaaa...\"}";
        // sdkRequest.setBody(json

登录后复制

以上就是使用OCI Java SDK为自定义REST请求生成认证签名的详细内容，更多请关注php中文网其它相关文章！