src/libs/utils/ssh/sshpacketparser_p.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef SSHPACKETPARSER_P_H
  35 #define SSHPACKETPARSER_P_H
  36
  37 #include <botan/bigint.h>
  38
  39 #include <QtCore/QByteArray>
  40 #include <QtCore/QList>
  41 #include <QtCore/QString>
  42
  43 namespace Utils {
  44 namespace Internal {
  45
  46 struct SshNameList
  47 {
  48     SshNameList() : originalLength(0) {}
  49     SshNameList(quint32 originalLength) : originalLength(originalLength) {}
  50     quint32 originalLength;
  51     QList<QByteArray> names;
  52 };
  53
  54 class SshPacketParseException { };
  55
  56 // This class's functions try to read a byte array at a certain offset
  57 // as the respective chunk of data as specified in the SSH RFCs.
  58 // If they succeed, they update the offset, so they can easily
  59 // be called in succession by client code.
  60 // For convenience, some have also versions that don't update the offset,
  61 // so they can be called with rvalues if the new value is not needed.
  62 // If they fail, they throw an SshPacketParseException.
  63 class SshPacketParser
  64 {
  65 public:
  66     static bool asBool(const QByteArray &data, quint32 offset);
  67     static bool asBool(const QByteArray &data, quint32 *offset);
  68     static quint16 asUint16(const QByteArray &data, quint32 offset);
  69     static quint16 asUint16(const QByteArray &data, quint32 *offset);
  70     static quint64 asUint64(const QByteArray &data, quint32 offset);
  71     static quint64 asUint64(const QByteArray &data, quint32 *offset);
  72     static quint32 asUint32(const QByteArray &data, quint32 offset);
  73     static quint32 asUint32(const QByteArray &data, quint32 *offset);
  74     static QByteArray asString(const QByteArray &data, quint32 *offset);
  75     static QString asUserString(const QByteArray &data, quint32 *offset);
  76     static SshNameList asNameList(const QByteArray &data, quint32 *offset);
  77     static Botan::BigInt asBigInt(const QByteArray &data, quint32 *offset);
  78
  79     static QString asUserString(const QByteArray &rawString);
  80 };
  81
  82 } // namespace Internal
  83 } // namespace Utils
  84
  85 #endif // SSHPACKETPARSER_P_H