View Javadoc
1   /*
2    * Copyright 2017 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty5.handler.ssl.ocsp;
17  
18  import io.netty5.channel.ChannelHandler;
19  import io.netty5.channel.ChannelHandlerContext;
20  import io.netty5.handler.ssl.ReferenceCountedOpenSslContext;
21  import io.netty5.handler.ssl.ReferenceCountedOpenSslEngine;
22  import io.netty5.handler.ssl.SslHandshakeCompletionEvent;
23  import io.netty5.util.internal.UnstableApi;
24  
25  import javax.net.ssl.SSLHandshakeException;
26  
27  import static java.util.Objects.requireNonNull;
28  
29  /**
30   * A handler for SSL clients to handle and act upon stapled OCSP responses.
31   *
32   * @see ReferenceCountedOpenSslContext#enableOcsp()
33   * @see ReferenceCountedOpenSslEngine#getOcspResponse()
34   */
35  @UnstableApi
36  public abstract class OcspClientHandler implements ChannelHandler {
37  
38      private final ReferenceCountedOpenSslEngine engine;
39  
40      protected OcspClientHandler(ReferenceCountedOpenSslEngine engine) {
41          this.engine = requireNonNull(engine, "engine");
42      }
43  
44      /**
45       * @see ReferenceCountedOpenSslEngine#getOcspResponse()
46       */
47      protected abstract boolean verify(ChannelHandlerContext ctx, ReferenceCountedOpenSslEngine engine) throws Exception;
48  
49      @Override
50      public void channelInboundEvent(ChannelHandlerContext ctx, Object evt) throws Exception {
51          ctx.fireChannelInboundEvent(evt);
52          if (evt instanceof SslHandshakeCompletionEvent) {
53              SslHandshakeCompletionEvent event = (SslHandshakeCompletionEvent) evt;
54              if (event.isSuccess() && !verify(ctx, engine)) {
55                  throw new SSLHandshakeException("Bad OCSP response");
56              }
57              ctx.pipeline().remove(this);
58          }
59      }
60  }