node-smb-server/lib/smb/cmd/trans2/trans2_query_fs_information.js

A Pure JavaScript SMB Server Implementation

/*
 *  Copyright 2015 Adobe Systems Incorporated. All rights reserved.
 *  This file is licensed to you under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License. You may obtain a copy
 *  of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software distributed under
 *  the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 *  OF ANY KIND, either express or implied. See the License for the specific language
 *  governing permissions and limitations under the License.
 */

'use strict';

var put = require('put');
var logger = require('winston').loggers.get('smb');

var ntstatus = require('../../../ntstatus');
var SMB = require('../../constants');
var utils = require('../../../utils');

var DEFAULT_SERIAL_NUMBER = 0xdabbad00;
// Maximum length of each file name component, in number of bytes.
var MAX_FILE_NAME_LENGTH = 255;
// File system. Returning values other than this may lead to problems.
var FILE_SYSTEM = 'NTFS';

// fake values for disk total/free size
var SECTORS_PER_UNIT = 8;
var BYTES_PER_SECTOR = 512;
var TOTAL_ALLOCATION_UNITS = 0x08000000;  // * SECTORS_PER_UNIT * BYTES_PER_SECTOR = 512gb

/**
 * TRANS2_QUERY_FS_INFORMATION (0x0003): This transaction is used to request information
 * about the object store underlying a share on the server.
 *
 * @param {Object} msg - an SMB message object
 * @param {Number} commandId - the command id
 * @param {Buffer} commandParams - the command parameters
 * @param {Buffer} commandData - the command data
 * @param {Number} commandParamsOffset - the command parameters offset within the SMB
 * @param {Number} commandDataOffset - the command data offset within the SMB
 * @param {Object} connection - an SMBConnection instance
 * @param {Object} server - an SMBServer instance
 * @param {Function} cb callback called with the command's result
 * @param {Object} cb.result - an object with the command's result params and data
 *                             or null if the handler already sent the response and
 *                             no further processing is required by the caller
 * @param {Number} cb.result.status
 * @param {Buffer} cb.result.params
 * @param {Buffer} cb.result.data
 */
function handle(msg, commandId, commandParams, commandData, commandParamsOffset, commandDataOffset, connection, server, cb) {
  var informationLevel = commandParams.readUInt16LE(0);

  logger.debug('[%s] informationLevel: %s', SMB.TRANS2_SUBCOMMAND_TO_STRING[commandId].toUpperCase(), SMB.QUERY_FS_INFORMATION_LEVEL_TO_STRING[informationLevel]);

  var tree = server.getTree(msg.header.tid);
  if (!tree) {
    result = {
      status: ntstatus.STATUS_SMB_BAD_TID,
      params: utils.EMPTY_BUFFER,
      data: utils.EMPTY_BUFFER
    };
    process.nextTick(function () { cb(result); });
    return;
  }

  var share = tree.getShare();
  var volumeLabel = share.getDescription();

  var result;

  var dataOut = put();
  // todo expose/retrieve these values through Share abstraction
  switch (informationLevel) {
    case SMB.QUERY_FS_INFO_ALLOCATION:
      dataOut.word32le(0) // idFileSystem
        .word32le(SECTORS_PER_UNIT) // cSectorUnit
        .word32le(TOTAL_ALLOCATION_UNITS) // cUnit
        .word32le(TOTAL_ALLOCATION_UNITS) // cUnitAvailable
        .word16le(BYTES_PER_SECTOR); // cbSector
      break;
    case SMB.QUERY_FS_INFO_VOLUME:
      dataOut.word32le(DEFAULT_SERIAL_NUMBER) // ulVolSerialNbr
        .word8(volumeLabel.length) // cCharCount
        .put(new Buffer(volumeLabel, 'utf16le'));  // VolumeLabel
      break;
    case SMB.QUERY_FS_VOLUME_INFO:
      var long = utils.systemToSMBTime(Date.now());
      dataOut.word32le(long.getLowBitsUnsigned()) // VolumeCreationTime
        .word32le(long.getHighBitsUnsigned())
        .word32le(DEFAULT_SERIAL_NUMBER) // SerialNumber
        .word32le(volumeLabel.length * 2)  // VolumeLabelSize
        .word16le(0)  // reserved
        .put(new Buffer(volumeLabel, 'utf16le'));  // VolumeLabel
      break;
    case SMB.QUERY_FS_SIZE_INFO:
      dataOut.word64le(TOTAL_ALLOCATION_UNITS) // TotalAllocationUnits
        .word64le(TOTAL_ALLOCATION_UNITS) // TotalFreeAllocationUnits
        .word32le(SECTORS_PER_UNIT) // SectorsPerAllocationUnit
        .word32le(BYTES_PER_SECTOR); // BytesPerSector
      break;
    case SMB.QUERY_FS_DEVICE_INFO:
      dataOut.word32le(SMB.FILE_DEVICE_DISK) // DeviceType
        .word32le(SMB.FILE_VIRTUAL_VOLUME); // DeviceCharacteristics
      break;
    case SMB.QUERY_FS_ATTRIBUTE_INFO:
      dataOut.word32le(SMB.FILE_CASE_SENSITIVE_SEARCH |
          SMB.FILE_CASE_PRESERVED_NAMES |
          //SMB.FILE_NAMED_STREAMS |
          SMB.FILE_UNICODE_ON_DISK) // FileSystemAttributes
        .word32le(MAX_FILE_NAME_LENGTH)  // MaxFileNameLengthInBytes
        .word32le(FILE_SYSTEM.length * 2)  // LengthOfFileSystemName
        .put(new Buffer(FILE_SYSTEM, 'utf16le'));  // FileSystemName
      break;
    default:
      result = {
        status: ntstatus.STATUS_OS2_INVALID_LEVEL,
        params: utils.EMPTY_BUFFER,
        data: utils.EMPTY_BUFFER
      };
      process.nextTick(function () { cb(result); });
      return;
  }
  var data = dataOut.buffer();

  result = {
    status: ntstatus.STATUS_SUCCESS,
    params: utils.EMPTY_BUFFER,
    data: data
  };
  process.nextTick(function () { cb(result); });
}

module.exports = handle;