netconf/netconf-netty-util/src/main/java/org/opendaylight/netconf/nettyutil/handler/NetconfXMLToMessageDecoder.java

   1 /*
   2  * Copyright (c) 2014 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.nettyutil.handler;
   9
  10 import io.netty.buffer.ByteBuf;
  11 import io.netty.buffer.ByteBufInputStream;
  12 import io.netty.buffer.ByteBufUtil;
  13 import io.netty.buffer.Unpooled;
  14 import io.netty.channel.ChannelHandlerContext;
  15 import io.netty.handler.codec.ByteToMessageDecoder;
  16 import java.io.IOException;
  17 import java.util.List;
  18 import org.opendaylight.controller.config.util.xml.XmlUtil;
  19 import org.opendaylight.netconf.api.NetconfMessage;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22 import org.xml.sax.SAXException;
  23
  24 public final class NetconfXMLToMessageDecoder extends ByteToMessageDecoder {
  25     private static final Logger LOG = LoggerFactory.getLogger(NetconfXMLToMessageDecoder.class);
  26
  27     @Override
  28     public void decode(final ChannelHandlerContext ctx, final ByteBuf in,
  29                        final List<Object> out) throws IOException, SAXException {
  30         if (in.isReadable()) {
  31             if (LOG.isTraceEnabled()) {
  32                 LOG.trace("Received to decode: {}", ByteBufUtil.hexDump(in));
  33             }
  34
  35             /* According to the XML 1.0 specifications, when there is an XML declaration
  36              * at the beginning of an XML document, it is invalid to have
  37              * white spaces before that declaration (reminder: a XML declaration looks like:
  38              * <?xml version="1.0" encoding="UTF-8"?>). In contrast, when there is no XML declaration,
  39              * it is valid to have white spaces at the beginning of the document.
  40              *
  41              * When they send a NETCONF message, several NETCONF servers start with a new line (either
  42              * LF or CRLF), presumably to improve readability in interactive sessions with a human being.
  43              * Some NETCONF servers send an XML declaration, some others do not.
  44              *
  45              * If a server starts a NETCONF message with white spaces and follows with an XML
  46              * declaration, XmlUtil.readXmlToDocument() will fail because this is invalid XML.
  47              * But in the spirit of the "NETCONF over SSH" RFC 4742 and to improve interoperability, we want
  48              * to accept those messages.
  49              *
  50              * To do this, the following code strips the leading bytes before the start of the XML messages.
  51              */
  52
  53             // Skip all leading whitespaces by moving the reader index to the first non whitespace character
  54             while (in.isReadable()) {
  55                 if (!isWhitespace(in.readByte())) {
  56                     // return reader index to the first non whitespace character
  57                     in.readerIndex(in.readerIndex() - 1);
  58                     break;
  59                 }
  60             }
  61
  62             // Warn about leading whitespaces
  63             if (in.readerIndex() != 0 && LOG.isWarnEnabled()) {
  64                 final byte[] strippedBytes = new byte[in.readerIndex()];
  65                 in.getBytes(0, strippedBytes, 0, in.readerIndex());
  66                 LOG.warn("XML message with unwanted leading bytes detected. Discarded the {} leading byte(s): '{}'",
  67                         in.readerIndex(), ByteBufUtil.hexDump(Unpooled.wrappedBuffer(strippedBytes)));
  68             }
  69         }
  70         if (in.isReadable()) {
  71             out.add(new NetconfMessage(XmlUtil.readXmlToDocument(new ByteBufInputStream(in))));
  72         } else {
  73             LOG.debug("No more content in incoming buffer.");
  74         }
  75     }
  76
  77     /**
  78      * Check whether a byte is whitespace/control character. Considered whitespace characters: <br/>
  79      * SPACE, \t, \n, \v, \r, \f
  80      *
  81      * @param byteToCheck byte to check
  82      * @return true if the byte is a whitespace/control character
  83      */
  84     private static boolean isWhitespace(final byte byteToCheck) {
  85         return byteToCheck <= 0x0d && byteToCheck >= 0x09 || byteToCheck == 0x20;
  86     }
  87 }