2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.ssh;
11 import com.google.common.base.Preconditions;
12 import io.netty.bootstrap.Bootstrap;
13 import io.netty.channel.Channel;
14 import io.netty.channel.ChannelFuture;
15 import io.netty.channel.ChannelInitializer;
16 import io.netty.channel.EventLoopGroup;
17 import io.netty.channel.local.LocalAddress;
18 import io.netty.channel.local.LocalChannel;
19 import java.io.InputStream;
20 import java.io.OutputStream;
21 import java.net.InetSocketAddress;
22 import java.net.SocketAddress;
23 import org.apache.sshd.common.NamedFactory;
24 import org.apache.sshd.common.io.IoInputStream;
25 import org.apache.sshd.common.io.IoOutputStream;
26 import org.apache.sshd.server.AsyncCommand;
27 import org.apache.sshd.server.Command;
28 import org.apache.sshd.server.Environment;
29 import org.apache.sshd.server.ExitCallback;
30 import org.apache.sshd.server.SessionAware;
31 import org.apache.sshd.server.session.ServerSession;
32 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
37 * This command handles all netconf related rpc and forwards to delegate server.
38 * Uses netty to make a local connection to delegate server.
41 * Command is Apache Mina SSH terminology for objects handling ssh data.
43 public class RemoteNetconfCommand implements AsyncCommand, SessionAware {
45 private static final Logger LOG = LoggerFactory.getLogger(RemoteNetconfCommand.class);
47 private final EventLoopGroup clientEventGroup;
48 private final LocalAddress localAddress;
50 private IoInputStream in;
51 private IoOutputStream out;
52 private ExitCallback callback;
53 private NetconfHelloMessageAdditionalHeader netconfHelloMessageAdditionalHeader;
55 private Channel clientChannel;
56 private ChannelFuture clientChannelFuture;
58 public RemoteNetconfCommand(final EventLoopGroup clientEventGroup, final LocalAddress localAddress) {
59 this.clientEventGroup = clientEventGroup;
60 this.localAddress = localAddress;
64 @SuppressWarnings("checkstyle:hiddenField")
65 public void setIoInputStream(final IoInputStream in) {
70 @SuppressWarnings("checkstyle:hiddenField")
71 public void setIoOutputStream(final IoOutputStream out) {
76 public void setIoErrorStream(final IoOutputStream err) {
77 // TODO do we want to use error stream in some way ?
81 @SuppressWarnings("checkstyle:hiddenField")
82 public void setInputStream(final InputStream in) {
83 throw new UnsupportedOperationException("Synchronous IO is unsupported");
87 @SuppressWarnings("checkstyle:hiddenField")
88 public void setOutputStream(final OutputStream out) {
89 throw new UnsupportedOperationException("Synchronous IO is unsupported");
94 public void setErrorStream(final OutputStream err) {
95 throw new UnsupportedOperationException("Synchronous IO is unsupported");
100 @SuppressWarnings("checkstyle:hiddenField")
101 public void setExitCallback(final ExitCallback callback) {
102 this.callback = callback;
106 public void start(final Environment env) {
107 LOG.trace("Establishing internal connection to netconf server for client: {}", getClientAddress());
109 final Bootstrap clientBootstrap = new Bootstrap();
110 clientBootstrap.group(clientEventGroup).channel(LocalChannel.class);
112 clientBootstrap.handler(new ChannelInitializer<LocalChannel>() {
114 public void initChannel(final LocalChannel ch) {
116 .addLast(new SshProxyClientHandler(in, out, netconfHelloMessageAdditionalHeader, callback));
119 clientChannelFuture = clientBootstrap.connect(localAddress);
120 clientChannelFuture.addListener(future -> {
121 if (future.isSuccess()) {
122 clientChannel = clientChannelFuture.channel();
124 LOG.warn("Unable to establish internal connection to netconf server for client: {}",
126 Preconditions.checkNotNull(callback, "Exit callback must be set");
127 callback.onExit(1, "Unable to establish internal connection to netconf server for client: "
128 + getClientAddress());
134 public void destroy() {
135 LOG.trace("Releasing internal connection to netconf server for client: {} on channel: {}",
136 getClientAddress(), clientChannel);
138 clientChannelFuture.cancel(true);
139 if (clientChannel != null) {
140 clientChannel.close().addListener(future -> {
141 if (!future.isSuccess()) {
142 LOG.warn("Unable to release internal connection to netconf server on channel: {}",
149 private String getClientAddress() {
150 return netconfHelloMessageAdditionalHeader.getAddress();
154 public void setSession(final ServerSession session) {
155 final SocketAddress remoteAddress = session.getIoSession().getRemoteAddress();
156 String hostName = "";
158 if (remoteAddress instanceof InetSocketAddress) {
159 hostName = ((InetSocketAddress) remoteAddress).getAddress().getHostAddress();
160 port = Integer.toString(((InetSocketAddress) remoteAddress).getPort());
162 netconfHelloMessageAdditionalHeader = new NetconfHelloMessageAdditionalHeader(
163 session.getUsername(), hostName, port, "ssh", "client");
166 public static class NetconfCommandFactory implements NamedFactory<Command> {
168 public static final String NETCONF = "netconf";
170 private final EventLoopGroup clientBootstrap;
171 private final LocalAddress localAddress;
173 public NetconfCommandFactory(final EventLoopGroup clientBootstrap, final LocalAddress localAddress) {
175 this.clientBootstrap = clientBootstrap;
176 this.localAddress = localAddress;
180 public String getName() {
185 public RemoteNetconfCommand create() {
186 return new RemoteNetconfCommand(clientBootstrap, localAddress);