Module: Rex::Proto::MSSQL::ClientMixin
- Extended by:
- Forwardable
- Includes:
- Msf::Module::UI::Message
- Included in:
- Client
- Defined in:
- lib/rex/proto/mssql/client_mixin.rb
Overview
A base mixin of useful mssql methods for parsing structures etc
Defined Under Namespace
Modules: ENVCHANGE
Constant Summary collapse
- ENCRYPT_OFF =
Encryption
0x00
- ENCRYPT_ON =
Encryption is available but off.
0x01
- ENCRYPT_NOT_SUP =
Encryption is available and on.
0x02
- ENCRYPT_REQ =
Encryption is not available.
0x03
- TYPE_SQL_BATCH =
Packet Type
1
- TYPE_PRE_TDS7_LOGIN =
(Client) SQL command
2
- TYPE_RPC =
(Client) Pre-login with version < 7 (unused)
3
- TYPE_TABLE_RESPONSE =
(Client) RPC
4
- TYPE_ATTENTION_SIGNAL =
Request Completion, Error and Info Messages, Attention Acknowledgement
6
- TYPE_BULK_LOAD =
(Client) Attention
7
- TYPE_TRANSACTION_MANAGER_REQUEST =
(Client) SQL Command with binary data
14
- TYPE_TDS7_LOGIN =
(Client) Transaction request manager
16
- TYPE_SSPI_MESSAGE =
(Client) Login
17
- TYPE_PRE_LOGIN_MESSAGE =
(Client) Login
18
- STATUS_NORMAL =
Status
0x00
- STATUS_END_OF_MESSAGE =
0x01
- STATUS_IGNORE_EVENT =
0x02
- STATUS_RESETCONNECTION =
TDS 7.1+
0x08
- STATUS_RESETCONNECTIONSKIPTRAN =
TDS 7.3+
0x10
Instance Method Summary collapse
-
#mssql_parse_done(data, info) ⇒ Object
Parse a “done” TDS token.
-
#mssql_parse_env(data, info) ⇒ Object
Parse an “environment change” TDS token.
-
#mssql_parse_error(data, info) ⇒ Object
Parse an “error” TDS token.
-
#mssql_parse_info(data, info) ⇒ Object
Parse an “information” TDS token.
-
#mssql_parse_login_ack(data, info) ⇒ Object
Parse a “login ack” TDS token.
-
#mssql_parse_reply(data, info) ⇒ Object
Parse individual tokens from a TDS reply.
-
#mssql_parse_ret(data, info) ⇒ Object
Parse a “ret” TDS token.
-
#mssql_parse_tds_reply(data, info) ⇒ Object
Parse a raw TDS reply from the server.
-
#mssql_parse_tds_row(data, info) ⇒ Object
Parse a single row of a TDS reply.
- #mssql_print_reply(info) ⇒ Object
- #mssql_send_recv(req, timeout = 15, check_status = true) ⇒ Object
-
#mssql_tds_encrypt(pass) ⇒ Object
Encrypt a password according to the TDS protocol (encode).
- #mssql_xpcmdshell(cmd, doprint = false, opts = {}) ⇒ Object
Methods included from Msf::Module::UI::Message
#print_error, #print_good, #print_prefix, #print_status, #print_warning
Methods included from Msf::Module::UI::Message::Verbose
#vprint_error, #vprint_good, #vprint_status, #vprint_warning
Instance Method Details
#mssql_parse_done(data, info) ⇒ Object
Parse a “done” TDS token
551 552 553 554 555 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 551 def mssql_parse_done(data, info) status, cmd, rows = data.slice!(0, 8).unpack('vvV') info[:done] = { :status => status, :cmd => cmd, :rows => rows } info end |
#mssql_parse_env(data, info) ⇒ Object
Parse an “environment change” TDS token
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 575 def mssql_parse_env(data, info) len = data.slice!(0, 2).unpack('v')[0] buff = data.slice!(0, len) type = buff.slice!(0, 1).unpack('C')[0] nval = '' nlen = buff.slice!(0, 1).unpack('C')[0] || 0 nval = buff.slice!(0, nlen * 2).gsub("\x00", '') if nlen > 0 oval = '' olen = buff.slice!(0, 1).unpack('C')[0] || 0 oval = buff.slice!(0, olen * 2).gsub("\x00", '') if olen > 0 info[:envs] ||= [] info[:envs] << { :type => type, :old => oval, :new => nval } self.current_database = nval if type == ENVCHANGE::DATABASE info end |
#mssql_parse_error(data, info) ⇒ Object
Parse an “error” TDS token
560 561 562 563 564 565 566 567 568 569 570 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 560 def mssql_parse_error(data, info) len = data.slice!(0, 2).unpack('v')[0] buff = data.slice!(0, len) errno, state, sev, elen = buff.slice!(0, 8).unpack('VCCv') emsg = buff.slice!(0, elen * 2) emsg.gsub!("\x00", '') info[:errors] << "SQL Server Error ##{errno} (State:#{state} Severity:#{sev}): #{emsg}" info end |
#mssql_parse_info(data, info) ⇒ Object
Parse an “information” TDS token
599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 599 def mssql_parse_info(data, info) len = data.slice!(0, 2).unpack('v')[0] buff = data.slice!(0, len) errno, state, sev, elen = buff.slice!(0, 8).unpack('VCCv') emsg = buff.slice!(0, elen * 2) emsg.gsub!("\x00", '') info[:infos] ||= [] info[:infos] << "SQL Server Info ##{errno} (State:#{state} Severity:#{sev}): #{emsg}" info end |
#mssql_parse_login_ack(data, info) ⇒ Object
Parse a “login ack” TDS token
615 616 617 618 619 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 615 def mssql_parse_login_ack(data, info) len = data.slice!(0, 2).unpack('v')[0] _buff = data.slice!(0, len) info[:login_ack] = true end |
#mssql_parse_reply(data, info) ⇒ Object
Parse individual tokens from a TDS reply
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 303 def mssql_parse_reply(data, info) info[:errors] = [] return if not data states = [] until data.empty? || info[:errors].any? token = data.slice!(0, 1).unpack('C')[0] case token when 0x81 states << :mssql_parse_tds_reply mssql_parse_tds_reply(data, info) when 0xd1 states << :mssql_parse_tds_row mssql_parse_tds_row(data, info) when 0xe3 states << :mssql_parse_env mssql_parse_env(data, info) when 0x79 states << :mssql_parse_ret mssql_parse_ret(data, info) when 0xfd, 0xfe, 0xff states << :mssql_parse_done mssql_parse_done(data, info) when 0xad states << :mssql_parse_login_ack mssql_parse_login_ack(data, info) when 0xab states << :mssql_parse_info mssql_parse_info(data, info) when 0xaa states << :mssql_parse_error mssql_parse_error(data, info) when nil break else info[:errors] << "unsupported token: #{token}. Previous states: #{states}" break end end info end |
#mssql_parse_ret(data, info) ⇒ Object
Parse a “ret” TDS token
542 543 544 545 546 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 542 def mssql_parse_ret(data, info) ret = data.slice!(0, 4).unpack('N')[0] info[:ret] = ret info end |
#mssql_parse_tds_reply(data, info) ⇒ Object
Parse a raw TDS reply from the server
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 164 def mssql_parse_tds_reply(data, info) info[:errors] ||= [] info[:colinfos] ||= [] info[:colnames] ||= [] # Parse out the columns cols = data.slice!(0, 2).unpack('v')[0] 0.upto(cols-1) do |col_idx| col = {} info[:colinfos][col_idx] = col col[:utype] = data.slice!(0, 2).unpack('v')[0] col[:flags] = data.slice!(0, 2).unpack('v')[0] col[:type] = data.slice!(0, 1).unpack('C')[0] case col[:type] when 48 col[:id] = :tinyint when 52 col[:id] = :smallint when 56 col[:id] = :rawint when 61 col[:id] = :datetime when 34 col[:id] = :image col[:max_size] = data.slice!(0, 4).unpack('V')[0] col[:value_length] = data.slice!(0, 2).unpack('v')[0] col[:value] = data.slice!(0, col[:value_length] * 2).gsub("\x00", '') when 109 col[:id] = :float col[:value_length] = data.slice!(0, 1).unpack('C')[0] when 108 col[:id] = :numeric col[:value_length] = data.slice!(0, 1).unpack('C')[0] col[:precision] = data.slice!(0, 1).unpack('C')[0] col[:scale] = data.slice!(0, 1).unpack('C')[0] when 60 col[:id] = :money when 110 col[:value_length] = data.slice!(0, 1).unpack('C')[0] case col[:value_length] when 8 col[:id] = :money when 4 col[:id] = :smallmoney else col[:id] = :unknown end when 111 col[:value_length] = data.slice!(0, 1).unpack('C')[0] case col[:value_length] when 4 col[:id] = :smalldatetime when 8 col[:id] = :datetime else col[:id] = :unknown end when 122 col[:id] = :smallmoney when 59 col[:id] = :float when 58 col[:id] = :smalldatetime when 36 col[:id] = :guid col[:value_length] = data.slice!(0, 1).unpack('C')[0] when 38 col[:id] = :int col[:int_size] = data.slice!(0, 1).unpack('C')[0] when 50 col[:id] = :bit when 99 col[:id] = :ntext col[:max_size] = data.slice!(0, 4).unpack('V')[0] col[:codepage] = data.slice!(0, 2).unpack('v')[0] col[:cflags] = data.slice!(0, 2).unpack('v')[0] col[:charset_id] = data.slice!(0, 1).unpack('C')[0] col[:namelen] = data.slice!(0, 1).unpack('C')[0] col[:table_name] = data.slice!(0, (col[:namelen] * 2) + 1).gsub("\x00", '') when 104 col[:id] = :bitn col[:int_size] = data.slice!(0, 1).unpack('C')[0] when 127 col[:id] = :bigint when 165 col[:id] = :hex col[:max_size] = data.slice!(0, 2).unpack('v')[0] when 173 col[:id] = :hex # binary(2) col[:max_size] = data.slice!(0, 2).unpack('v')[0] when 231, 175, 167, 239 col[:id] = :string col[:max_size] = data.slice!(0, 2).unpack('v')[0] col[:codepage] = data.slice!(0, 2).unpack('v')[0] col[:cflags] = data.slice!(0, 2).unpack('v')[0] col[:charset_id] = data.slice!(0, 1).unpack('C')[0] else col[:id] = :unknown # See https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-tds/ce3183a6-9d89-47e8-a02f-de5a1a1303de for details about column types info[:errors] << "Unsupported column type: #{col[:type]}. " return info end col[:msg_len] = data.slice!(0, 1).unpack('C')[0] if col[:msg_len] && col[:msg_len] > 0 col[:name] = data.slice!(0, col[:msg_len] * 2).gsub("\x00", '') end info[:colnames] << (col[:name] || 'NULL') end end |
#mssql_parse_tds_row(data, info) ⇒ Object
Parse a single row of a TDS reply
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 347 def mssql_parse_tds_row(data, info) info[:rows] ||= [] row = [] info[:colinfos].each do |col| if(data.length == 0) row << "<EMPTY>" next end case col[:id] when :hex str = "" len = data.slice!(0, 2).unpack('v')[0] if len > 0 && len < 65535 str << data.slice!(0, len) end row << str.unpack("H*")[0] when :guid read_length = data.slice!(0, 1).unpack1('C') if read_length == 0 row << nil else row << Rex::Text.to_guid(data.slice!(0, read_length)) end when :string str = "" len = data.slice!(0, 2).unpack('v')[0] if len > 0 && len < 65535 str << data.slice!(0, len) end row << str.gsub("\x00", '') when :ntext str = nil ptrlen = data.slice!(0, 1).unpack("C")[0] ptr = data.slice!(0, ptrlen) unless ptrlen == 0 = data.slice!(0, 8) datalen = data.slice!(0, 4).unpack("V")[0] if datalen > 0 && datalen < 65535 str = data.slice!(0, datalen).gsub("\x00", '') else str = '' end end row << str when :float datalen = data.slice!(0, 1).unpack('C')[0] case datalen when 8 row << data.slice!(0, datalen).unpack('E')[0] when 4 row << data.slice!(0, datalen).unpack('e')[0] else row << nil end when :numeric varlen = data.slice!(0, 1).unpack('C')[0] if varlen == 0 row << nil else sign = data.slice!(0, 1).unpack('C')[0] raw = data.slice!(0, varlen - 1) value = '' case varlen when 5 value = raw.unpack('L')[0]/(10**col[:scale]).to_f when 9 value = raw.unpack('Q')[0]/(10**col[:scale]).to_f when 13 chunks = raw.unpack('L3') value = chunks[2] << 64 | chunks[1] << 32 | chunks[0] value /= (10**col[:scale]).to_f when 17 chunks = raw.unpack('L4') value = chunks[3] << 96 | chunks[2] << 64 | chunks[1] << 32 | chunks[0] value /= (10**col[:scale]).to_f end case sign when 1 row << value when 0 row << value * -1 end end when :money datalen = data.slice!(0, 1).unpack('C')[0] if datalen == 0 row << nil else raw = data.slice!(0, datalen) rev = raw.slice(4, 4) << raw.slice(0, 4) row << rev.unpack('q')[0]/10000.0 end when :smallmoney datalen = data.slice!(0, 1).unpack('C')[0] if datalen == 0 row << nil else row << data.slice!(0, datalen).unpack('l')[0] / 10000.0 end when :smalldatetime datalen = data.slice!(0, 1).unpack('C')[0] if datalen == 0 row << nil else days = data.slice!(0, 2).unpack('S')[0] minutes = data.slice!(0, 2).unpack('S')[0] / 1440.0 row << DateTime.new(1900, 1, 1) + days + minutes end when :datetime datalen = data.slice!(0, 1).unpack('C')[0] if datalen == 0 row << nil else days = data.slice!(0, 4).unpack('l')[0] minutes = data.slice!(0, 4).unpack('l')[0] / 1440.0 row << DateTime.new(1900, 1, 1) + days + minutes end when :rawint row << data.slice!(0, 4).unpack('V')[0] when :bigint row << data.slice!(0, 8).unpack("H*")[0] when :smallint row << data.slice!(0, 2).unpack("v")[0] when :smallint3 row << [data.slice!(0, 3)].pack("Z4").unpack("V")[0] when :tinyint row << data.slice!(0, 1).unpack("C")[0] when :bitn has_value = data.slice!(0, 1).unpack("C")[0] if has_value == 0 row << nil else row << data.slice!(0, 1).unpack("C")[0] end when :bit row << data.slice!(0, 1).unpack("C")[0] when :image str = '' len = data.slice!(0, 1).unpack('C')[0] str = data.slice!(0, len) if len && len > 0 row << str.unpack("H*")[0] when :int len = data.slice!(0, 1).unpack("C")[0] raw = data.slice!(0, len) if len && len > 0 case len when 0, 255 row << '' when 1 row << raw.unpack("C")[0] when 2 row << raw.unpack('v')[0] when 4 row << raw.unpack('V')[0] when 5 row << raw.unpack('V')[0] # XXX: missing high byte when 8 row << raw.unpack('VV')[0] # XXX: missing high dword else info[:errors] << "invalid integer size: #{len} #{data[0, 16].unpack("H*")[0]}" end else info[:errors] << "unknown column type: #{col.inspect}" end end info[:rows] << row info end |
#mssql_print_reply(info) ⇒ Object
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 59 def mssql_print_reply(info) print_status("SQL Query: #{info[:sql]}") if info[:done] && info[:done][:rows].to_i > 0 print_status("Row Count: #{info[:done][:rows]} (Status: #{info[:done][:status]} Command: #{info[:done][:cmd]})") end if info[:errors] && !info[:errors].empty? info[:errors].each do |err| print_error(err) end end if info[:rows] && !info[:rows].empty? tbl = Rex::Text::Table.new( 'Indent' => 1, 'Header' => "Response", 'Columns' => info[:colnames], 'SortIndex' => -1 ) info[:rows].each do |row| tbl << row.map{ |x| x.nil? ? 'nil' : x } end print_line(tbl.to_s) end end |
#mssql_send_recv(req, timeout = 15, check_status = true) ⇒ Object
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 89 def mssql_send_recv(req, timeout=15, check_status = true) sock.put(req) # Read the 8 byte header to get the length and status # Read the length to get the data # If the status is 0, read another header and more data done = false resp = "" while(not done) head = sock.get_once(8, timeout) if !(head && head.length == 8) return false end # Is this the last buffer? if head[1, 1] == "\x01" || !check_status done = true end # Grab this block's length rlen = head[2, 2].unpack('n')[0] - 8 while(rlen > 0) buff = sock.get_once(rlen, timeout) return if not buff resp << buff rlen -= buff.length end end resp end |
#mssql_tds_encrypt(pass) ⇒ Object
Encrypt a password according to the TDS protocol (encode)
127 128 129 130 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 127 def mssql_tds_encrypt(pass) # Convert to unicode, swap 4 bits both ways, xor with 0xa5 Rex::Text.to_unicode(pass).unpack('C*').map {|c| (((c & 0x0f) << 4) + ((c & 0xf0) >> 4)) ^ 0xa5 }.pack("C*") end |
#mssql_xpcmdshell(cmd, doprint = false, opts = {}) ⇒ Object
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/rex/proto/mssql/client_mixin.rb', line 132 def mssql_xpcmdshell(cmd, doprint=false, opts={}) force_enable = false begin res = query("EXEC master..xp_cmdshell '#{cmd}'", false, opts) if res[:errors] && !res[:errors].empty? if res[:errors].join =~ /xp_cmdshell/ if force_enable print_error("The xp_cmdshell procedure is not available and could not be enabled") raise RuntimeError, "Failed to execute command" else print_status("The server may have xp_cmdshell disabled, trying to enable it...") query(mssql_xpcmdshell_enable()) raise RuntimeError, "xp_cmdshell disabled" end end end mssql_print_reply(res) if doprint return res rescue RuntimeError => e if e.to_s =~ /xp_cmdshell disabled/ force_enable = true retry end raise e end end |