protocol/netconf-server/src/main/java/org/opendaylight/netconf/server/NetconfServerSession.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.server;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static com.google.common.base.Verify.verify;
  12
  13 import com.google.common.net.InetAddresses;
  14 import io.netty.channel.Channel;
  15 import io.netty.channel.ChannelFuture;
  16 import io.netty.handler.codec.ByteToMessageDecoder;
  17 import io.netty.handler.codec.MessageToByteEncoder;
  18 import java.net.Inet4Address;
  19 import java.net.InetAddress;
  20 import java.time.Instant;
  21 import java.time.ZoneId;
  22 import java.time.ZonedDateTime;
  23 import java.time.format.DateTimeFormatter;
  24 import java.util.regex.Pattern;
  25 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
  26 import org.opendaylight.netconf.api.messages.NetconfMessage;
  27 import org.opendaylight.netconf.api.messages.NotificationMessage;
  28 import org.opendaylight.netconf.nettyutil.AbstractNetconfSession;
  29 import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
  30 import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
  31 import org.opendaylight.netconf.server.api.monitoring.NetconfManagementSession;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfSsh;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Transport;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.SessionKey;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.monitoring.rev220718.NetconfTcp;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.monitoring.rev220718.Session1Builder;
  46 import org.opendaylight.yangtools.yang.common.Uint32;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 public final class NetconfServerSession extends AbstractNetconfSession<NetconfServerSession,
  51         NetconfServerSessionListener> implements NetconfManagementSession {
  52     private static final Logger LOG = LoggerFactory.getLogger(NetconfServerSession.class);
  53     private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
  54     private static final Pattern DATE_TIME_PATTERN;
  55
  56     static {
  57         verify(DateAndTime.PATTERN_CONSTANTS.size() == 1);
  58         DATE_TIME_PATTERN = Pattern.compile(DateAndTime.PATTERN_CONSTANTS.get(0));
  59     }
  60
  61     private final NetconfHelloMessageAdditionalHeader header;
  62     private final NetconfServerSessionListener sessionListener;
  63
  64     private ZonedDateTime loginTime;
  65     private long inRpcSuccess;
  66     private long inRpcFail;
  67     private long outRpcError;
  68     private long outNotification;
  69     private volatile boolean delayedClose;
  70
  71     public NetconfServerSession(final NetconfServerSessionListener sessionListener, final Channel channel,
  72                                 final SessionIdType sessionId, final NetconfHelloMessageAdditionalHeader header) {
  73         super(sessionListener, channel, sessionId);
  74         this.header = header;
  75         this.sessionListener = sessionListener;
  76         LOG.debug("Session {} created", this);
  77     }
  78
  79     @Override
  80     protected void sessionUp() {
  81         checkState(loginTime == null, "Session is already up");
  82         loginTime = Instant.now().atZone(ZoneId.systemDefault());
  83         super.sessionUp();
  84     }
  85
  86     /**
  87      * Close this session after next message is sent.
  88      * Suitable for close rpc that needs to send ok response before the session is closed.
  89      */
  90     public void delayedClose() {
  91         delayedClose = true;
  92     }
  93
  94     @Override
  95     public ChannelFuture sendMessage(final NetconfMessage netconfMessage) {
  96         final ChannelFuture channelFuture = super.sendMessage(netconfMessage);
  97         if (netconfMessage instanceof NotificationMessage notification) {
  98             outNotification++;
  99             sessionListener.onNotification(this, notification);
 100         }
 101         // delayed close was set, close after the message was sent
 102         if (delayedClose) {
 103             channelFuture.addListener(future -> close());
 104         }
 105         return channelFuture;
 106     }
 107
 108     public void onIncommingRpcSuccess() {
 109         inRpcSuccess++;
 110     }
 111
 112     public void onIncommingRpcFail() {
 113         inRpcFail++;
 114     }
 115
 116     public void onOutgoingRpcError() {
 117         outRpcError++;
 118     }
 119
 120     @Override
 121     public Session toManagementSession() {
 122         final SessionBuilder builder = new SessionBuilder().withKey(new SessionKey(sessionId().getValue()));
 123         final InetAddress address1 = InetAddresses.forString(header.getAddress());
 124         final IpAddress address;
 125         if (address1 instanceof Inet4Address) {
 126             address = new IpAddress(new Ipv4Address(header.getAddress()));
 127         } else {
 128             address = new IpAddress(new Ipv6Address(header.getAddress()));
 129         }
 130         builder.setSourceHost(new Host(address));
 131
 132         final String formattedDateTime = DATE_FORMATTER.format(loginTime);
 133         checkState(DATE_TIME_PATTERN.matcher(formattedDateTime).matches(),
 134             "Formatted datetime %s does not match pattern %s", formattedDateTime, DATE_TIME_PATTERN);
 135
 136         return builder
 137                 .setLoginTime(new DateAndTime(formattedDateTime))
 138                 .setInBadRpcs(new ZeroBasedCounter32(Uint32.valueOf(inRpcFail)))
 139                 .setInRpcs(new ZeroBasedCounter32(Uint32.valueOf(inRpcSuccess)))
 140                 .setOutRpcErrors(new ZeroBasedCounter32(Uint32.valueOf(outRpcError)))
 141                 .setUsername(header.getUserName())
 142                 .setTransport(getTransportForString(header.getTransport()))
 143                 .setOutNotifications(new ZeroBasedCounter32(Uint32.valueOf(outNotification)))
 144                 .addAugmentation(new Session1Builder().setSessionIdentifier(header.getSessionIdentifier()).build())
 145                 .build();
 146     }
 147
 148     private static Transport getTransportForString(final String transport) {
 149         return switch (transport) {
 150             case "ssh" -> NetconfSsh.VALUE;
 151             case "tcp" -> NetconfTcp.VALUE;
 152             default -> throw new IllegalArgumentException("Unknown transport type " + transport);
 153         };
 154     }
 155
 156     @Override
 157     protected NetconfServerSession thisInstance() {
 158         return this;
 159     }
 160
 161     @Override
 162     protected void addExiHandlers(final ByteToMessageDecoder decoder,
 163                                   final MessageToByteEncoder<NetconfMessage> encoder) {
 164         replaceMessageDecoder(decoder);
 165         replaceMessageEncoderAfterNextMessage(encoder);
 166     }
 167
 168     @Override
 169     public void stopExiCommunication() {
 170         replaceMessageDecoder(new NetconfXMLToMessageDecoder());
 171         replaceMessageEncoderAfterNextMessage(new NetconfMessageToXMLEncoder());
 172     }
 173 }