github-advanced-security[bot] commented on code in PR #703: URL: https://github.com/apache/httpcomponents-client/pull/703#discussion_r2265281657
########## httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientZstdCompressionExample.java: ########## @@ -0,0 +1,191 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ +package org.apache.hc.client5.http.examples; + +import java.io.ByteArrayOutputStream; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.util.concurrent.Future; + +import org.apache.commons.compress.compressors.CompressorInputStream; +import org.apache.commons.compress.compressors.CompressorStreamFactory; +import org.apache.hc.client5.http.async.methods.DeflatingZstdEntityProducer; +import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; +import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; +import org.apache.hc.client5.http.entity.compress.ContentCoding; +import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; +import org.apache.hc.client5.http.impl.async.HttpAsyncClients; +import org.apache.hc.core5.http.ClassicHttpRequest; +import org.apache.hc.core5.http.ClassicHttpResponse; +import org.apache.hc.core5.http.ContentType; +import org.apache.hc.core5.http.HttpEntity; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.HttpResponse; +import org.apache.hc.core5.http.HttpStatus; +import org.apache.hc.core5.http.Message; +import org.apache.hc.core5.http.impl.bootstrap.HttpServer; +import org.apache.hc.core5.http.impl.bootstrap.ServerBootstrap; +import org.apache.hc.core5.http.io.HttpRequestHandler; +import org.apache.hc.core5.http.io.entity.StringEntity; +import org.apache.hc.core5.http.nio.entity.StringAsyncEntityConsumer; +import org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer; +import org.apache.hc.core5.http.nio.support.BasicRequestProducer; +import org.apache.hc.core5.http.nio.support.BasicResponseConsumer; +import org.apache.hc.core5.http.protocol.HttpContext; +import org.apache.hc.core5.io.CloseMode; + +/** + * Example: streaming a request body compressed with Zstandard (zstd) using the async client. + * + * <p>This example runs entirely with HttpComponents. It starts a tiny classic + * {@code HttpCore 5} server on an ephemeral port that <em>decodes</em> requests carrying + * {@code Content-Encoding: zstd} (via Apache Commons Compress) and echoes the plain text. + * The async client builds the request body with + * {@link org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer} and wraps it in + * {@link org.apache.hc.client5.http.async.methods.DeflatingZstdEntityProducer} so the payload + * is compressed <strong>on the fly</strong> as it is streamed to the wire (no {@code InputStream} + * in the client pipeline).</p> + * + * <h3>What it demonstrates</h3> + * <ul> + * <li>How to send a POST request whose entity is compressed with <b>zstd</b> while streaming.</li> + * <li>How to advertise the request coding with {@code Content-Encoding: zstd}.</li> + * <li>Chunked transfer with proper back-pressure handling on the client side.</li> + * </ul> + * + * <h3>Outline</h3> + * <ol> + * <li>Start an embedded classic server that accepts {@code /echo} and, if present, + * decodes {@code Content-Encoding: zstd} before reading the text; it replies with + * plain text.</li> + * <li>Create the default async client.</li> + * <li>Wrap the plain entity in {@link org.apache.hc.client5.http.async.methods.DeflatingZstdEntityProducer} + * and send it with {@link org.apache.hc.core5.http.nio.support.BasicRequestProducer}.</li> + * <li>Read the echoed response as a string (normal, uncompressed text).</li> + * </ol> + * + * <h3>Expected output</h3> + * <pre>{@code + * Request : Hello Zstandard request body! + * Status : 200 + * Response: echo: Hello Zstandard request body! + * }</pre> + * + * <h3>Notes</h3> + * <ul> + * <li>The <em>client</em> path is fully NIO and ByteBuffer-based; no {@code InputStream} is used.</li> + * <li>The embedded server in this example uses Apache Commons Compress <em>only</em> to decode + * incoming zstd for demonstration; production servers may decode differently.</li> + * <li>Ensure {@code com.github.luben:zstd-jni} is on the runtime classpath for the client.</li> + * </ul> + * + * @since 5.6 + */ + +public final class AsyncClientZstdCompressionExample { + + public static void main(final String[] args) throws Exception { + // --- tiny classic server that decodes zstd requests and echoes plain text --- + final HttpServer server = ServerBootstrap.bootstrap() + .setListenerPort(0) + .setCanonicalHostName("localhost") + .register("/echo", new EchoHandler()) + .create(); + server.start(); + final int port = server.getLocalPort(); + final String url = "http://localhost:"; + port + "/echo"; + + try (CloseableHttpAsyncClient client = HttpAsyncClients.createDefault()) { + client.start(); + + final String payload = "Hello Zstandard request body!"; + System.out.println("Request : " + payload); + + final StringAsyncEntityProducer plain = new StringAsyncEntityProducer(payload, ContentType.TEXT_PLAIN); + final DeflatingZstdEntityProducer zstd = new DeflatingZstdEntityProducer(plain); + + final SimpleHttpRequest post = SimpleRequestBuilder.post(url) + // header is optional; BasicRequestProducer will use producer metadata too + .setHeader(HttpHeaders.CONTENT_ENCODING, ContentCoding.ZSTD.token()) + .setHeader(HttpHeaders.CONTENT_TYPE, ContentType.TEXT_PLAIN.toString()) + .build(); + + final Future<Message<HttpResponse, String>> f = client.execute( + new BasicRequestProducer(post, zstd), + new BasicResponseConsumer<>(new StringAsyncEntityConsumer()), + null); + + final Message<HttpResponse, String> msg = f.get(); + System.out.println("Status : " + msg.getHead().getCode()); + System.out.println("Response: " + msg.getBody()); + } finally { + server.close(CloseMode.GRACEFUL); + } + } + + /** + * Classic echo handler that decodes request Content-Encoding: zstd and returns plain text. + */ + private static final class EchoHandler implements HttpRequestHandler { + @Override + public void handle(final ClassicHttpRequest request, + final ClassicHttpResponse response, + final HttpContext context) { + try { + final HttpEntity ent = request.getEntity(); + final byte[] body; + if (ent != null && hasZstd(ent)) { + try (InputStream in = ent.getContent(); + CompressorInputStream zin = new CompressorStreamFactory() + .createCompressorInputStream("zstd", in)) { + body = readAll(zin); + } + } else { + body = ent != null ? readAll(ent.getContent()) : new byte[0]; + } + final String text = new String(body, StandardCharsets.UTF_8); + response.setCode(HttpStatus.SC_OK); + response.setEntity(new StringEntity("echo: " + text, ContentType.TEXT_PLAIN)); Review Comment: ## Cross-site scripting Cross-site scripting vulnerability due to a [user-provided value](1). [Show more details](https://github.com/apache/httpcomponents-client/security/code-scanning/19) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
