dstruct 0.0.1

data/lib/rex/proto/iax2/codecs/mulaw.rb

@@ -0,0 +1,17 @@
+# -*- coding: binary -*-
+module Rex
+module Proto
+module IAX2
+module Codecs
+class MuLaw < G711
+
+
+  def self.decode(buff)
+    buff.unpack("C*").map{ |x| LOOKUP_ULAW2LIN16[x] }.pack('v*')
+  end
+
+end
+end
+end
+end
+end

data/lib/rex/proto/iax2/constants.rb

@@ -0,0 +1,262 @@
+# -*- coding: binary -*-
+module Rex
+module Proto
+module IAX2
+
+
+IAX2_DEFAULT_PORT = 4569
+
+
+IAX_TYPE_VOICE   = 2
+IAX_TYPE_CONTROL = 4
+IAX_TYPE_IAX     = 6
+IAX_TYPE_DTMF_BEGIN = 1
+IAX_TYPE_DTMF_END   = 12
+
+IAX_CTRL_HANGUP   = 1
+IAX_CTRL_RINGING  = 3
+IAX_CTRL_ANSWER   = 4
+IAX_CTRL_BUSY     = 5
+IAX_CTRL_PROGRESS = 14
+IAX_CTRL_PROCEED  = 15
+
+=begin
+   +-------------+---------------+-------------------------------------+
+   | VALUE       | Name          | Description                         |
+   +-------------+---------------+-------------------------------------+
+   | 0x01        | Hangup        | The call has been hungup at the     |
+   |             |               | remote end                          |
+   |             |               |                                     |
+   | 0x02        | Reserved      | Reserved for future use             |
+   |             |               |                                     |
+   | 0x03        | Ringing       | Remote end is ringing (ring-back)   |
+   |             |               |                                     |
+   | 0x04        | Answer        | Remote end has answered             |
+   |             |               |                                     |
+   | 0x05        | Busy          | Remote end is busy                  |
+   |             |               |                                     |
+   | 0x06        | Reserved      | Reserved for future use             |
+   |             |               |                                     |
+   | 0x07        | Reserved      | Reserved for future use             |
+   |             |               |                                     |
+   | 0x08        | Congestion    | The call is congested               |
+   |             |               |                                     |
+   | 0x09        | Flash Hook    | Flash hook                          |
+   |             |               |                                     |
+   | 0x0a        | Reserved      | Reserved for future use             |
+   |             |               |                                     |
+   | 0x0b        | Option        | Device-specific options are being   |
+   |             |               | transmitted                         |
+   |             |               |                                     |
+   | 0x0c        | Key Radio     | Key Radio                           |
+   |             |               |                                     |
+   | 0x0d        | Unkey Radio   | Unkey Radio                         |
+   |             |               |                                     |
+   | 0x0e        | Call Progress | Call is in progress                 |
+   |             |               |                                     |
+   | 0x0f        | Call          | Call is proceeding                  |
+   |             | Proceeding    |                                     |
+   |             |               |                                     |
+   | 0x10        | Hold          | Call is placed on hold              |
+   |             |               |                                     |
+   | 0x11        | Unhold        | Call is taken off hold              |
+   +-------------+---------------+-------------------------------------+
+=end
+
+
+IAX_SUBTYPE_NEW     = 1
+IAX_SUBTYPE_PING    = 2
+IAX_SUBTYPE_PONG    = 3
+IAX_SUBTYPE_ANSWER  = 4
+IAX_SUBTYPE_ACK     = 4
+IAX_SUBTYPE_HANGUP  = 5
+IAX_SUBTYPE_REJECT  = 6
+IAX_SUBTYPE_ACCEPT  = 7
+IAX_SUBTYPE_AUTHREQ = 8
+IAX_SUBTYPE_AUTHREP = 9
+IAX_SUBTYPE_INVAL   = 10
+IAX_SUBTYPE_LAGRQ   = 11
+IAX_SUBTYPE_LAGRP   = 12
+IAX_SUBTYPE_REGREQ  = 13
+IAX_SUBTYPE_REGAUTH = 14
+IAX_SUBTYPE_REGACK  = 15
+IAX_SUBTYPE_REGREJ  = 16
+IAX_SUBTYPE_REGREL  = 17
+IAX_SUBTYPE_VNAK    = 18
+
+=begin
+      +------+-----------+-----------------------------------------+
+      | Hex  | Name      | Description                             |
+      +------+-----------+-----------------------------------------+
+      | 0x01 | NEW       | Initiate a new call                     |
+      |      |           |                                         |
+      | 0x02 | PING      | Ping request                            |
+      |      |           |                                         |
+      | 0x03 | PONG      | Ping or poke reply                      |
+      |      |           |                                         |
+      | 0x04 | ACK       | Explicit acknowledgment                 |
+      |      |           |                                         |
+      | 0x05 | HANGUP    | Initiate call tear-down                 |
+      |      |           |                                         |
+      | 0x06 | REJECT    | Reject a call                           |
+      |      |           |                                         |
+      | 0x07 | ACCEPT    | Accept a call                           |
+      |      |           |                                         |
+      | 0x08 | AUTHREQ   | Authentication request                  |
+      |      |           |                                         |
+      | 0x09 | AUTHREP   | Authentication reply                    |
+      |      |           |                                         |
+      | 0x0a | INVAL     | Invalid message                         |
+      |      |           |                                         |
+      | 0x0b | LAGRQ     | Lag request                             |
+      |      |           |                                         |
+      | 0x0c | LAGRP     | Lag reply                               |
+      |      |           |                                         |
+      | 0x0d | REGREQ    | Registration request                    |
+      |      |           |                                         |
+      | 0x0e | REGAUTH   | Registration authentication             |
+      |      |           |                                         |
+      | 0x0f | REGACK    | Registration acknowledgement            |
+      |      |           |                                         |
+      | 0x10 | REGREJ    | Registration reject                     |
+      |      |           |                                         |
+      | 0x11 | REGREL    | Registration release                    |
+      |      |           |                                         |
+      | 0x12 | VNAK      | Video/Voice retransmit request          |
+      |      |           |                                         |
+      | 0x13 | DPREQ     | Dialplan request                        |
+      |      |           |                                         |
+      | 0x14 | DPREP     | Dialplan reply                          |
+      |      |           |                                         |
+      | 0x15 | DIAL      | Dial                                    |
+      |      |           |                                         |
+      | 0x16 | TXREQ     | Transfer request                        |
+      |      |           |                                         |
+      | 0x17 | TXCNT     | Transfer connect                        |
+      |      |           |                                         |
+      | 0x18 | TXACC     | Transfer accept                         |
+      |      |           |                                         |
+      | 0x19 | TXREADY   | Transfer ready                          |
+      |      |           |                                         |
+      | 0x1a | TXREL     | Transfer release                        |
+      |      |           |                                         |
+      | 0x1b | TXREJ     | Transfer reject                         |
+      |      |           |                                         |
+      | 0x1c | QUELCH    | Halt audio/video [media] transmission   |
+      |      |           |                                         |
+      | 0x1d | UNQUELCH  | Resume audio/video [media] transmission |
+      |      |           |                                         |
+      | 0x1e | POKE      | Poke request                            |
+      |      |           |                                         |
+      | 0x1f | Reserved  | Reserved for future use                 |
+      |      |           |                                         |
+      | 0x20 | MWI       | Message waiting indication              |
+      |      |           |                                         |
+      | 0x21 | UNSUPPORT | Unsupported message                     |
+      |      |           |                                         |
+      | 0x22 | TRANSFER  | Remote transfer request                 |
+      |      |           |                                         |
+      | 0x23 | Reserved  | Reserved for future use                 |
+      |      |           |                                         |
+      | 0x24 | Reserved  | Reserved for future use                 |
+      |      |           |                                         |
+      | 0x25 | Reserved  | Reserved for future use                 |
+      +------+-----------+-----------------------------------------+
+=end
+
+IAX_IE_CALLED_NUMBER  = 1
+IAX_IE_CALLING_NUMBER = 2
+IAX_IE_AUTH_METHODS   = 3
+IAX_IE_CALLING_NAME   = 4
+IAX_IE_USERNAME       = 6
+IAX_IE_DESIRED_CODEC  = 9
+IAX_IE_ORIGINAL_DID   = 10
+IAX_IE_ACTUAL_CODECS  = 8
+IAX_IE_PROTO_VERSION  = 11
+IAX_IE_REG_REFRESH    = 19
+IAX_IE_CHALLENGE_DATA = 15
+IAX_IE_CHALLENGE_RESP = 16
+IAX_IE_APPARENT_ADDR  = 18
+IAX_IE_REGREJ_CAUSE   = 22
+IAX_IE_HANGUP_CAUSE   = 42
+
+=begin
+ +------+----------------+-------------------------------------------+
+   | HEX  | NAME           | DESCRIPTION                               |
+   +------+----------------+-------------------------------------------+
+   | HEX  | NAME           | DESCRIPTION                               |
+   | 0x01 | CALLED NUMBER  | Number/extension being called             |
+   | 0x02 | CALLING NUMBER | Calling number                            |
+   | 0x03 | CALLING ANI    | Calling number ANI for billing            |
+   | 0x04 | CALLING NAME   | Name of caller                            |
+   | 0x05 | CALLED CONTEXT | Context for number                        |
+   | 0x06 | USERNAME       | Username (peer or user) for               |
+   |      |                | authentication                            |
+   | 0x07 | PASSWORD       | Password for authentication               |
+   | 0x08 | CAPABILITY     | Actual CODEC capability                   |
+   | 0x09 | FORMAT         | Desired CODEC format                      |
+   | 0x0a | LANGUAGE       | Desired language                          |
+   | 0x0b | VERSION        | Protocol version                          |
+   | 0x0c | ADSICPE        | CPE ADSI capability                       |
+   | 0x0d | DNID           | Originally dialed DNID                    |
+   | 0x0e | AUTHMETHODS    | Authentication method(s)                  |
+   | 0x0f | CHALLENGE      | Challenge data for MD5/RSA                |
+   | 0x10 | MD5 RESULT     | MD5 challenge result                      |
+   | 0x11 | RSA RESULT     | RSA challenge result                      |
+   | 0x12 | APPARENT ADDR  | Apparent address of peer                  |
+   | 0x13 | REFRESH        | When to refresh registration              |
+   | 0x14 | DPSTATUS       | Dialplan status                           |
+   | 0x15 | CALLNO         | Call number of peer                       |
+   | 0x16 | CAUSE          | Cause                                     |
+   | 0x17 | IAX UNKNOWN    | Unknown IAX command                       |
+   | 0x18 | MSGCOUNT       | How many messages waiting                 |
+   | 0x19 | AUTOANSWER     | Request auto-answering                    |
+   | 0x1a | MUSICONHOLD    | Request musiconhold with QUELCH           |
+   | 0x1b | TRANSFERID     | Transfer Request Identifier               |
+   | 0x1c | RDNIS          | Referring DNIS                            |
+   | 0x1d | Reserved       | Reserved for future use                   |
+   | 0x1e | Reserved       | Reserved for future use                   |
+   | 0x1f | DATETIME       | Date/Time                                 |
+   | 0x20 | Reserved       | Reserved for future use                   |
+   | 0x21 | Reserved       | Reserved for future use                   |
+   | 0x22 | Reserved       | Reserved for future use                   |
+   | 0x23 | Reserved       | Reserved for future use                   |
+   | 0x24 | Reserved       | Reserved for future use                   |
+   | 0x25 | Reserved       | Reserved for future use                   |
+   | 0x26 | CALLINGPRES    | Calling presentation                      |
+   | 0x27 | CALLINGTON     | Calling type of number                    |
+   | 0x28 | CALLINGTNS     | Calling transit network select            |
+   | 0x29 | SAMPLINGRATE   | Supported sampling rates                  |
+   | 0x2a | CAUSECODE      | Hangup cause                              |
+   | 0x2b | ENCRYPTION     | Encryption format                         |
+   | 0x2c | ENCKEY         | Reserved for future Use                   |
+   | 0x2d | CODEC PREFS    | CODEC Negotiation                         |
+   | 0x2e | RR JITTER      | Received jitter, as in RFC 3550           |
+   | 0x2f | RR LOSS        | Received loss, as in RFC 3550             |
+   | 0x30 | RR PKTS        | Received frames                           |
+   | 0x31 | RR DELAY       | Max playout delay for received frames in  |
+   |      |                | ms                                        |
+   | 0x32 | RR DROPPED     | Dropped frames (presumably by jitter      |
+   |      |                | buffer)                                   |
+   | 0x33 | RR OOO         | Frames received Out of Order              |
+   | 0x34 | OSPTOKEN       | OSP Token Block                           |
+   +------+----------------+-------------------------------------------+
+=end
+
+
+# Codecs
+IAX_CODEC_G711_MULAW  = 0x00000004
+IAX_CODEC_G711_ALAW   = 0x00000008
+IAX_CODEC_LINEAR_PCM  = 0x00000040
+
+# Supported
+IAX_SUPPORTED_CODECS  = IAX_CODEC_G711_MULAW | IAX_CODEC_G711_ALAW | IAX_CODEC_LINEAR_PCM
+
+# Default timings
+IAX_DEFAULT_REG_REFRESH = 60
+IAX_DEFAULT_TIMEOUT     = 10
+
+
+end
+end
+end

data/lib/rex/proto/ipmi.rb

@@ -0,0 +1,57 @@
+# -*- coding: binary -*-
+
+require 'rex/proto/ipmi/utils'
+
+module Rex
+module Proto
+module IPMI
+  require 'bit-struct'
+  require 'rex/proto/ipmi/channel_auth_reply'
+  require 'rex/proto/ipmi/open_session_reply'
+  require 'rex/proto/ipmi/rakp2'
+
+  #
+  # Move these into an IPMI stack or mixin at some point
+  #
+
+  #
+  # Payload types were identified from xCAT-server source code (IPMI.pm)
+  #
+  PAYLOAD_IPMI = 0
+  PAYLOAD_SOL  = 1
+  PAYLOAD_RMCPPLUSOPEN_REQ = 0x10
+  PAYLOAD_RMCPPLUSOPEN_REP = 0x11
+  PAYLOAD_RAKP1 = 0x12
+  PAYLOAD_RAKP2 = 0x13
+  PAYLOAD_RAKP3 = 0x14
+  PAYLOAD_RAKP4 = 0x15
+
+
+  #
+  # Payload types were copied from xCAT-server source code (IPMI.pm)
+  #
+  RMCP_ERRORS = {
+    1 => "Insufficient resources to create new session (wait for existing sessions to timeout)",
+    2 => "Invalid Session ID", #this shouldn't occur...
+    3 => "Invalid payload type",#shouldn't occur..
+    4 => "Invalid authentication algorithm", #if this happens, we need to enhance our mechanism for detecting supported auth algorithms
+    5 => "Invalid integrity algorithm", #same as above
+    6 => "No matching authentication payload",
+    7 => "No matching integrity payload",
+    8 => "Inactive Session ID", #this suggests the session was timed out while trying to negotiate, shouldn't happen
+    9 => "Invalid role",
+    0xa => "Unauthorised role or privilege level requested",
+    0xb => "Insufficient resources to create a session at the requested role",
+    0xc => "Invalid username length",
+    0xd => "Unauthorized name",
+    0xe => "Unauthorized GUID",
+    0xf => "Invalid integrity check value",
+    0x10 => "Invalid confidentiality algorithm",
+    0x11 => "No cipher suite match with proposed security algorithms",
+    0x12 => "Illegal or unrecognized parameter", #have never observed this, would most likely mean a bug in xCAT or IPMI device
+  }
+
+
+end
+end
+end

data/lib/rex/proto/ipmi/channel_auth_reply.rb

@@ -0,0 +1,89 @@
+# -*- coding: binary -*-
+
+module Rex
+module Proto
+module IPMI
+
+class Channel_Auth_Reply < BitStruct
+  unsigned :rmcp_version,                    8,     "RMCP Version"
+  unsigned :rmcp_padding,                    8,     "RMCP Padding"
+  unsigned :rmcp_sequence,                   8,     "RMCP Sequence"
+  unsigned :rmcp_mtype,                      1,     "RMCP Message Type"
+  unsigned :rmcp_class,                      7,     "RMCP Message Class"
+
+  unsigned :session_auth_type,               8,     "Session Auth Type"
+  unsigned :session_sequence,               32,     "Session Sequence Number"
+  unsigned :session_id,                     32,     "Session ID"
+  unsigned :message_length,                  8,     "Message Length"
+
+  unsigned :ipmi_tgt_address,                8,     "IPMI Target Address"
+  unsigned :ipmi_tgt_lun,                    8,     "IPMI Target LUN"
+  unsigned :ipmi_header_checksum,            8,     "IPMI Header Checksum"
+  unsigned :ipmi_src_address,                8,     "IPMI Source Address"
+  unsigned :ipmi_src_lun,                    8,     "IPMI Source LUN"
+  unsigned :ipmi_command,                    8,     "IPMI Command"
+  unsigned :ipmi_completion_code,            8,     "IPMI Completion Code"
+
+  unsigned :ipmi_channel,                    8,     "IPMI Channel"
+
+  unsigned :ipmi_compat_20,                  1,     "IPMI Version Compatibility: IPMI 2.0+"
+  unsigned :ipmi_compat_reserved1,           1,     "IPMI Version Compatibility: Reserved 1"
+  unsigned :ipmi_compat_oem_auth,            1,     "IPMI Version Compatibility: OEM Authentication"
+  unsigned :ipmi_compat_password,            1,     "IPMI Version Compatibility: Straight Password"
+  unsigned :ipmi_compat_reserved2,           1,     "IPMI Version Compatibility: Reserved 2"
+  unsigned :ipmi_compat_md5,                 1,     "IPMI Version Compatibility: MD5"
+  unsigned :ipmi_compat_md2,                 1,     "IPMI Version Compatibility: MD2"
+  unsigned :ipmi_compat_none,                1,     "IPMI Version Compatibility: None"
+
+  unsigned :ipmi_user_reserved1,             2,     "IPMI User Compatibility: Reserved 1"
+  unsigned :ipmi_user_kg,                    1,     "IPMI User Compatibility: KG Set to Default"
+  unsigned :ipmi_user_disable_message_auth,  1,     "IPMI User Compatibility: Disable Per-Message Authentication"
+  unsigned :ipmi_user_disable_user_auth,     1,     "IPMI User Compatibility: Disable User-Level Authentication"
+  unsigned :ipmi_user_non_null,              1,     "IPMI User Compatibility: Non-Null Usernames Enabled"
+  unsigned :ipmi_user_null,                  1,     "IPMI User Compatibility: Null Usernames Enabled"
+  unsigned :ipmi_user_anonymous,             1,     "IPMI User Compatibility: Anonymous Login Enabled"
+
+  unsigned :ipmi_conn_reserved1,             6,     "IPMI Connection Compatibility: Reserved 1"
+  unsigned :ipmi_conn_20,                    1,     "IPMI Connection Compatibility: 2.0"
+  unsigned :ipmi_conn_15,                    1,     "IPMI Connection Compatibility: 1.5"
+
+  unsigned :ipmi_oem_id,                    24,     "IPMI OEM ID", :endian => 'little'
+
+  rest :ipm_oem_data, "IPMI OEM Data + Checksum Byte"
+
+
+  def to_banner
+    info   = self
+    banner = "#{(info.ipmi_compat_20 == 1) ? "IPMI-2.0" : "IPMI-1.5"} "
+
+    pass_info = []
+    pass_info << "oem_auth" if info.ipmi_compat_oem_auth == 1
+    pass_info << "password" if info.ipmi_compat_password == 1
+    pass_info << "md5" if info.ipmi_compat_md5 == 1
+    pass_info << "md2" if info.ipmi_compat_md2 == 1
+    pass_info << "null" if info.ipmi_compat_none == 1
+
+    user_info = []
+    user_info << "kg_default" if (info.ipmi_compat_20 == 1 and info.ipmi_user_kg == 1)
+    user_info << "auth_msg" unless info.ipmi_user_disable_message_auth == 1
+    user_info << "auth_user" unless info.ipmi_user_disable_user_auth == 1
+    user_info << "non_null_user" if info.ipmi_user_non_null == 1
+    user_info << "null_user" if info.ipmi_user_null == 1
+    user_info << "anonymous_user" if info.ipmi_user_anonymous == 1
+
+    conn_info = []
+    conn_info << "1.5" if info.ipmi_conn_15 == 1
+    conn_info << "2.0" if info.ipmi_conn_20 == 1
+
+    if info.ipmi_oem_id != 0
+      banner << "OEMID:#{info.ipmi_oem_id} "
+    end
+
+    banner << "UserAuth(#{user_info.join(", ")}) PassAuth(#{pass_info.join(", ")}) Level(#{conn_info.join(", ")}) "
+    banner
+  end
+end
+
+end
+end
+end

data/lib/rex/proto/ipmi/open_session_reply.rb

@@ -0,0 +1,36 @@
+# -*- coding: binary -*-
+
+module Rex
+module Proto
+module IPMI
+
+class Open_Session_Reply < BitStruct
+  unsigned :rmcp_version,  8,  "RMCP Version"
+  unsigned :rmcp_padding,  8,  "RMCP Padding"
+  unsigned :rmcp_sequence, 8,  "RMCP Sequence"
+  unsigned :rmcp_mtype,    1,  "RMCP Message Type"
+  unsigned :rmcp_class,    7,  "RMCP Message Class"
+
+  unsigned :session_auth_type, 8,  "Authentication Type"
+
+  unsigned :session_payload_encrypted,     1,  "Session Payload Encrypted"
+  unsigned :session_payload_authenticated, 1,  "Session Payload Authenticated"
+  unsigned :session_payload_type,          6,  "Session Payload Type", :endian => 'little'
+
+  unsigned :session_id,       32,  "Session ID"
+  unsigned :session_sequence, 32,  "Session Sequence Number"
+  unsigned :message_length,   16,  "Message Length", :endian => "little"
+
+  unsigned :ignored1,        8, "Ignored"
+  unsigned :error_code,      8, "RMCP Error Code"
+  unsigned :ignored2,       16, "Ignored"
+  char :console_session_id, 32, "Console Session ID"
+  char :bmc_session_id,     32, "BMC Session ID"
+
+  rest :stuff, "The Rest of the Stuff"
+end
+
+end
+end
+end
+