ref: bc762e9c9294990c0d2480295637c792363dcc8c
dir: /lib/lua/nseport/afp.lua/
local stdnse = require "stdnse"
local datetime = require "datetime"
local ipOps = require "ipOps"
local os = require "os"
local string = require "string"
local stringaux = require "stringaux"
local table = require "table"
local net = require "net"
_ENV = stdnse.module("afp", stdnse.seeall);
local HAVE_SSL, openssl = pcall(require,'openssl')
-- Table of valid REQUESTs
local REQUEST = {
CloseSession = 0x01,
OpenSession = 0x04,
Command = 0x02,
GetStatus = 0x03,
Write = 0x06,
}
-- Table of headers flags to be set accordingly in requests and responses
local FLAGS = {
Request = 0,
Response = 1
}
-- Table of possible AFP_COMMANDs
COMMAND = {
FPCloseVol = 0x02,
FPCloseFork = 0x04,
FPCopyFile = 0x05,
FPCreateDir = 0x06,
FPCreateFile = 0x07,
FPGetSrvrInfo = 0x0f,
FPGetSrvParms = 0x10,
FPLogin = 0x12,
FPLoginCont = 0x13,
FPLogout = 0x14,
FPMapId = 0x15,
FPMapName = 0x16,
FPGetUserInfo = 0x25,
FPOpenVol = 0x18,
FPOpenFork = 0x1a,
FPGetFileDirParams = 0x22,
FPChangePassword = 0x24,
FPReadExt = 0x3c,
FPWriteExt = 0x3d,
FPGetAuthMethods = 0x3e,
FPLoginExt = 0x3f,
FPEnumerateExt2 = 0x44,
}
USER_BITMAP = {
UserId = 0x01,
PrimaryGroupId = 0x2,
UUID = 0x4
}
VOL_BITMAP = {
Attributes = 0x1,
Signature = 0x2,
CreationDate = 0x4,
ModificationDate = 0x8,
BackupDate = 0x10,
ID = 0x20,
BytesFree = 0x40,
BytesTotal = 0x80,
Name = 0x100,
ExtendedBytesFree = 0x200,
ExtendedBytesTotal = 0x400,
BlockSize = 0x800
}
FILE_BITMAP = {
Attributes = 0x1,
ParentDirId = 0x2,
CreationDate = 0x4,
ModificationDate = 0x8,
BackupDate = 0x10,
FinderInfo = 0x20,
LongName = 0x40,
ShortName = 0x80,
NodeId = 0x100,
DataForkSize = 0x200,
ResourceForkSize = 0x400,
ExtendedDataForkSize = 0x800,
LaunchLimit = 0x1000,
UTF8Name = 0x2000,
ExtendedResourceForkSize = 0x4000,
UnixPrivileges = 0x8000,
ALL = 0xFFFF
}
DIR_BITMAP = {
Attributes = 0x1,
ParentDirId = 0x2,
CreationDate = 0x4,
ModificationDate = 0x8,
BackupDate = 0x10,
FinderInfo = 0x20,
LongName = 0x40,
ShortName = 0x80,
NodeId = 0x100,
OffspringCount = 0x200,
OwnerId = 0x400,
GroupId = 0x800,
AccessRights = 0x1000,
UTF8Name = 0x2000,
UnixPrivileges = 0x8000,
ALL = 0xBFFF,
}
PATH_TYPE = {
ShortName = 1,
LongName = 2,
UTF8Name = 3,
}
ACCESS_MODE = {
Read = 0x1,
Write = 0x2,
DenyRead = 0x10,
DenyWrite = 0x20
}
-- Access controls
ACLS = {
OwnerSearch = 0x1,
OwnerRead = 0x2,
OwnerWrite = 0x4,
GroupSearch = 0x100,
GroupRead = 0x200,
GroupWrite = 0x400,
EveryoneSearch = 0x10000,
EveryoneRead = 0x20000,
EveryoneWrite = 0x40000,
UserSearch = 0x100000,
UserRead = 0x200000,
UserWrite = 0x400000,
BlankAccess = 0x10000000,
UserIsOwner = 0x80000000
}
-- User authentication modules
UAM =
{
NoUserAuth = "No User Authent",
ClearText = "Cleartxt Passwrd",
RandNum = "Randnum Exchange",
TwoWayRandNum = "2-Way Randnum",
DHCAST128 = "DHCAST128",
DHX2 = "DHX2",
Kerberos = "Client Krb v2",
Reconnect = "Recon1",
}
ERROR =
{
SocketError = 1000,
CustomError = 0xdeadbeef,
FPNoErr = 0,
FPAccessDenied = -5000,
FPAuthContinue = -5001,
FPBadUAM = -5002,
FPBadVersNum = -5003,
FPBitmapErr = - 5004,
FPCantMove = - 5005,
FPEOFErr = -5009,
FPItemNotFound = -5012,
FPLockErr = -5013,
FPMiscErr = -5014,
FPObjectExists = -5017,
FPObjectNotFound = -5018,
FPParamErr = -5019,
FPUserNotAuth = -5023,
FPCallNotSupported = -5024,
}
MAP_ID =
{
UserIDToName = 1,
GroupIDToName = 2,
UserIDToUTF8Name = 3,
GroupIDToUTF8Name = 4,
UserUUIDToUTF8Name = 5,
GroupUUIDToUTF8Name = 6
}
MAP_NAME =
{
NameToUserID = 1,
NameToGroupID = 2,
UTF8NameToUserID = 3,
UTF8NameToGroupID = 4,
UTF8NameToUserUUID = 5,
UTF8NameToGroupUUID = 6
}
SERVERFLAGS =
{
CopyFile = 0x01,
ChangeablePasswords = 0x02,
NoPasswordSaving = 0x04,
ServerMessages = 0x08,
ServerSignature = 0x10,
TCPoverIP = 0x20,
ServerNotifications = 0x40,
Reconnect = 0x80,
OpenDirectory = 0x100,
UTF8ServerName = 0x200,
UUIDs = 0x400,
SuperClient = 0x8000
}
local ERROR_MSG = {
[ERROR.FPAccessDenied]="Access Denied",
[ERROR.FPAuthContinue]="Authentication is not yet complete",
[ERROR.FPBadUAM]="Specified UAM is unknown",
[ERROR.FPBadVersNum]="Server does not support the specified AFP version",
[ERROR.FPBitmapErr]="Attempt was made to get or set a parameter that cannot be obtained or set with this command, or a required bitmap is null",
[ERROR.FPCantMove]="Attempt was made to move a directory into one of its descendant directories.",
[ERROR.FPEOFErr]="No more matches or end of fork reached.",
[ERROR.FPLockErr]="Some or all of the requested range is locked by another user; a lock range conflict exists.",
[ERROR.FPMiscErr]="Non-AFP error occurred.",
[ERROR.FPObjectNotFound]="Input parameters do not point to an existing directory, file, or volume.",
[ERROR.FPParamErr]="Parameter error.",
[ERROR.FPObjectExists] = "File or directory already exists.",
[ERROR.FPUserNotAuth] = "UAM failed (the specified old password doesn't match); no user is logged in yet for the specified session; authentication failed; password is incorrect.",
[ERROR.FPItemNotFound] = "Specified APPL mapping, comment, or icon was not found in the Desktop database; specified ID is unknown.",
[ERROR.FPCallNotSupported] = "Server does not support this command.",
}
-- Dates are shifted forward one day to avoid referencing 12/31/1969 UTC
-- when specifying 1/1/1970 (local) in a timezone that is ahead of UTC
local TIME_OFFSET = os.time({year=2000, month=1, day=2, hour=0}) - os.time({year=1970, month=1, day=2, hour=0})
-- Check if all the bits in flag are set in bitmap.
local function flag_is_set(bitmap, flag)
return (bitmap & flag) == flag
end
-- Serialize path of a given type
-- NB: For now the actual UTF-8 encoding is ignored
local function encode_path (path)
if path.type == PATH_TYPE.ShortName or path.type == PATH_TYPE.LongName then
return string.pack("Bs1", path.type, path.name)
elseif path.type == PATH_TYPE.UTF8Name then
return string.pack(">BI4s2", path.type, 0x08000103, path.name)
end
assert(false, ("Unrecognized path type '%s'"):format(tostring(path.type)))
end
-- Response class returned by all functions in Proto
Response = {
new = function(self,o)
o = o or {}
setmetatable(o, self)
self.__index = self
return o
end,
--- Sets the error code
--
-- @param code number containing the error code
setErrorCode = function( self, code )
self.error_code = code
end,
--- Gets the error code
--
-- @return code number containing the error code
getErrorCode = function( self )
return self.error_code
end,
--- Gets the error message
--
-- @return msg string containing the error
getErrorMessage = function(self)
if self.error_msg then
return self.error_msg
else
return ERROR_MSG[self.error_code] or ("Unknown error (%d) occurred"):format(self.error_code)
end
end,
--- Sets the error message
--
-- @param msg string containing the error message
setErrorMessage = function(self, msg)
self.error_code = ERROR.CustomError
self.error_msg = msg
end,
--- Sets the result
--
-- @param result result to set
setResult = function(self, result)
self.result = result
end,
--- Get the result
--
-- @return result
getResult = function(self)
return self.result
end,
--- Sets the packet
setPacket = function( self, packet )
self.packet = packet
end,
getPacket = function( self )
return self.packet
end,
--- Gets the packet data
getPacketData = function(self)
return self.packet.data
end,
--- Gets the packet header
getPacketHeader = function(self)
return self.packet.header
end,
}
--- Proto class containing all AFP specific code
--
-- For more details consult:
-- http://developer.apple.com/mac/library/documentation/Networking/Reference/AFP_Reference/Reference/reference.html
Proto = {
RequestId = 1,
new = function(self,o)
o = o or {}
setmetatable(o, self)
self.__index = self
return o
end,
setSocket = function(self, socket)
self.socket = socket
end,
--- Creates an AFP packet
--
-- @param command number should be one of the commands in the COMMAND table
-- @param data_offset number holding the offset to the data
-- @param data the actual data of the request
create_fp_packet = function( self, command, data_offset, data )
local reserved = 0
local data = data or ""
local data_len = data:len()
local header = string.pack(">BBI2I4I4I4", FLAGS.Request, command, self.RequestId, data_offset, data_len, reserved)
self.RequestId = self.RequestId + 1
return header .. data
end,
--- Parses the FP header (first 16-bytes of packet)
--
-- @param packet string containing the raw packet
-- @return table with header data containing <code>flags</code>, <code>command</code>,
-- <code>request_id</code>, <code>error_code</code>, <code>length</code> and <code>reserved</code> fields
parse_fp_header = function( self, packet )
local header = {}
local pos
header.flags, header.command, header.request_id, pos = string.unpack( ">BBI2", packet )
header.error_code, header.length, header.reserved, pos = string.unpack( ">i4I4I4", packet, pos )
if header.error_code ~= 0 then
header.error_msg = ERROR_MSG[header.error_code] or ("Unknown error: %d"):format(header.error_code)
header.error_msg = "ERROR: " .. header.error_msg
end
header.raw = packet:sub(1,16)
return header
end,
--- Reads a AFP packet of the socket
--
-- @return Response object
read_fp_packet = function( self )
local packet = {}
local buf = ""
local status, response
status, buf = self.socket:receive_bytes(16)
if ( not status ) then
response = Response:new()
response:setErrorCode(ERROR.SocketError)
response:setErrorMessage(buf)
return response
end
packet.header = self:parse_fp_header( buf )
while buf:len() < packet.header.length + packet.header.raw:len() do
local tmp
status, tmp = self.socket:receive_bytes( packet.header.length + 16 - buf:len() )
if not status then
response = Response:new()
response:setErrorCode(ERROR.SocketError)
response:setErrorMessage(buf)
return response
end
buf = buf .. tmp
end
packet.data = buf:len() > 16 and buf:sub( 17 ) or ""
response = Response:new()
response:setErrorCode(packet.header.error_code)
response:setPacket(packet)
return response
end,
--- Sends the raw packet over the socket
--
-- @param packet containing the raw data
-- @return Response object
send_fp_packet = function( self, packet )
return self.socket:send(packet)
end,
--- Sends an DSIOpenSession request to the server and handles the response
--
-- @return Response object
dsi_open_session = function( self, host, port )
local data_offset = 0
local option = 0x01 -- Attention Quantum
local option_len = 4
local quantum = 1024
local data, packet, status
data = string.pack( ">BBI4", option, option_len, quantum )
packet = self:create_fp_packet( REQUEST.OpenSession, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet()
end,
--- Sends an DSICloseSession request to the server and handles the response
dsi_close_session = function( self )
local data_offset = 0
local option = 0x01 -- Attention Quantum
local option_len = 4
local quantum = 1024
local data, packet, status
data = ""
packet = self:create_fp_packet( REQUEST.CloseSession, data_offset, data )
self:send_fp_packet( packet )
end,
-- Sends an FPCopyFile request to the server
--
-- @param src_vol number containing the ID of the src file volume
-- @param srd_did number containing the directory id of the src file
-- @param src_path string containing the file path/name of the src file
-- @param dst_vol number containing the ID of the dst file volume
-- @param dst_did number containing the id of the dest. directory
-- @param dst_path string containing the dest path (can be nil or "")
-- @param new_name string containing the new name of the destination
-- @return Response object
fp_copy_file = function(self, src_vol, src_did, src_path, dst_vol, dst_did, dst_path, new_name )
local data_offset = 0
local unicode_names, unicode_hint = 0x03, 0x08000103
local data, packet, response
-- make sure we have empty names rather than nil values
local dst_path = dst_path or ""
local src_path = src_path or ""
local new_name = new_name or ""
data = string.pack(">BxI2I4I2I4", COMMAND.FPCopyFile, src_vol, src_did, dst_vol, dst_did )
.. encode_path({type=PATH_TYPE.UTF8Name, name=src_path})
.. encode_path({type=PATH_TYPE.UTF8Name, name=dst_path})
.. encode_path({type=PATH_TYPE.UTF8Name, name=new_name})
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet()
end,
--- Sends an GetStatus DSI request (which is basically a FPGetSrvrInfo
-- AFP request) to the server and handles the response
--
-- @return status (true or false)
-- @return table with server information (if status is true) or error string
-- (if status is false)
fp_get_server_info = function(self)
local packet
local data_offset = 0
local response, result = {}, {}
local offsets = {}
local pos
local status
local data = string.pack("Bx", COMMAND.FPGetSrvrInfo)
packet = self:create_fp_packet(REQUEST.GetStatus, data_offset, data)
self:send_fp_packet(packet)
response = self:read_fp_packet()
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
packet = response.packet
-- parse and store the offsets in the 'header'
offsets.machine_type, offsets.afp_version_count,
offsets.uam_count, offsets.volume_icon_and_mask, pos
= string.unpack(">I2I2I2I2", packet.data)
-- the flags are directly in the 'header'
result.flags = {}
result.flags.raw, pos = string.unpack(">I2", packet.data, pos)
-- the short server name is stored directly in the 'header' as
-- well
result.server_name, pos = string.unpack("s1", packet.data, pos)
-- Server offset should begin at an even boundary see link below
-- http://developer.apple.com/mac/library/documentation/Networking/Reference/AFP_Reference/Reference/reference.html#//apple_ref/doc/uid/TP40003548-CH3-CHDIEGED
if (pos + 1) % 2 ~= 0 then
pos = pos + 1
end
-- and some more offsets
offsets.server_signature, offsets.network_addresses_count,
offsets.directory_names_count, offsets.utf8_server_name, pos
= string.unpack(">I2I2I2I2", packet.data, pos)
-- this sets up all the server flags in the response table as booleans
result.flags.SuperClient = flag_is_set(result.flags.raw, SERVERFLAGS.SuperClient)
result.flags.UUIDs = flag_is_set(result.flags.raw, SERVERFLAGS.UUIDs)
result.flags.UTF8ServerName = flag_is_set(result.flags.raw, SERVERFLAGS.UTF8ServerName)
result.flags.OpenDirectory = flag_is_set(result.flags.raw, SERVERFLAGS.OpenDirectory)
result.flags.Reconnect = flag_is_set(result.flags.raw, SERVERFLAGS.Reconnect)
result.flags.ServerNotifications = flag_is_set(result.flags.raw, SERVERFLAGS.ServerNotifications)
result.flags.TCPoverIP = flag_is_set(result.flags.raw, SERVERFLAGS.TCPoverIP)
result.flags.ServerSignature = flag_is_set(result.flags.raw, SERVERFLAGS.ServerSignature)
result.flags.ServerMessages = flag_is_set(result.flags.raw, SERVERFLAGS.ServerMessages)
result.flags.NoPasswordSaving = flag_is_set(result.flags.raw, SERVERFLAGS.NoPasswordSaving)
result.flags.ChangeablePasswords = flag_is_set(result.flags.raw, SERVERFLAGS.ChangeablePasswords)
result.flags.CopyFile = flag_is_set(result.flags.raw, SERVERFLAGS.CopyFile)
-- store the machine type
result.machine_type = string.unpack("s1", packet.data, offsets.machine_type + 1)
-- this tells us the number of afp versions supported
result.afp_version_count, pos = string.unpack("B", packet.data, offsets.afp_version_count + 1)
-- now we loop through them all, storing for the response
result.afp_versions = {}
for i = 1,result.afp_version_count do
local v
v, pos = string.unpack("s1", packet.data, pos)
table.insert(result.afp_versions, v)
end
-- same idea as the afp versions here
result.uam_count, pos = string.unpack("B", packet.data, offsets.uam_count + 1)
result.uams = {}
for i = 1,result.uam_count do
local uam
uam, pos = string.unpack("s1", packet.data, pos)
table.insert(result.uams, uam)
end
-- volume_icon_and_mask would normally be parsed out here,
-- however the apple docs say it is deprecated in Mac OS X, so
-- we don't bother with it
-- server signature is 16 bytes
result.server_signature = string.sub(packet.data, offsets.server_signature + 1, offsets.server_signature + 16)
-- this is the same idea as afp_version and uam above
result.network_addresses_count, pos = string.unpack("B", packet.data, offsets.network_addresses_count + 1)
result.network_addresses = {}
-- gets a little complicated in here, basically each entry has
-- a length byte, a tag byte, and then the data. We parse
-- differently based on the tag
for i = 1, result.network_addresses_count do
local length
local tag
length, tag, pos = string.unpack("BB", packet.data, pos)
if tag == 0x00 then
-- reserved, shouldn't ever come up, maybe this should
-- return an error? maybe not, lets just ignore this
elseif tag == 0x01 then
-- four byte ip
local ip
ip, pos = string.unpack("c4", packet.data, pos)
table.insert(result.network_addresses, ipOps.str_to_ip(ip))
elseif tag == 0x02 then
-- four byte ip and two byte port
local ip, port
ip, port, pos = string.unpack("c4 >I2", packet.data, pos)
table.insert(result.network_addresses, string.format("%s:%d", ipOps.str_to_ip(ip), port))
elseif tag == 0x03 then
-- ddp address (two byte network, one byte
-- node, one byte socket) not tested, anyone
-- use ddp anymore?
local network, node, socket
network, node, socket, pos = string.unpack(">I2BB", packet.data, pos)
table.insert(result.network_addresses, string.format("ddp %d.%d:%d", network, node, socket))
elseif tag == 0x04 then
-- dns name (string)
local temp
temp, pos = string.unpack("z", packet.data:sub(1,pos+length-3), pos)
table.insert(result.network_addresses, temp)
elseif tag == 0x05 then
-- four byte ip and two byte port, client
-- should use ssh. not tested, should work as it
-- is the same as tag 0x02
local ip, port
ip, port, pos = string.unpack("c4 >I2", packet.data, pos)
table.insert(result.network_addresses, string.format("ssh://%s:%d", ipOps.str_to_ip(ip), port))
elseif tag == 0x06 then
-- 16 byte ipv6
-- not tested, but should work (next tag is
-- tested)
local ip
ip, pos = string.unpack("c16", packet.data, pos)
table.insert(result.network_addresses, ipOps.str_to_ip(ip))
elseif tag == 0x07 then
-- 16 byte ipv6 and two byte port
local ip, port
ip, port, pos = string.unpack(">c16 I2", packet.data, pos)
table.insert(result.network_addresses,
string.format("[%s]:%d", ipOps.str_to_ip(ip), port))
end
end
-- same idea as the others here
result.directory_names_count, pos = string.unpack("B", packet.data, offsets.directory_names_count + 1)
result.directory_names = {}
for i = 1, result.directory_names_count do
local dirname
dirname, pos = string.unpack("s1", packet.data, pos)
table.insert(result.directory_names, dirname)
end
-- only one utf8 server name. note this string has a two-byte length.
result.utf8_server_name = string.unpack(">s2", packet.data, offsets.utf8_server_name + 1)
response.result = result
return response
end,
--- Sends an FPGetUserInfo AFP request to the server and handles the response
--
-- @return response object with the following result <code>user_bitmap</code> and
-- <code>uid</code> fields
fp_get_user_info = function( self )
local packet, pos, status, response
local data_offset = 0
local flags = 1 -- Default User
local uid = 0
local bitmap = USER_BITMAP.UserId
local result = {}
local data = string.pack( ">BBI4I2", COMMAND.FPGetUserInfo, flags, uid, bitmap )
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet()
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
response.result.user_bitmap, response.result.uid, pos = string.unpack(">I2I4", packet.data)
return response
end,
--- Sends an FPGetSrvrParms AFP request to the server and handles the response
--
-- @return response object with the following result <code>server_time</code>,
-- <code>vol_count</code>, <code>volumes</code> fields
fp_get_srvr_parms = function(self)
local packet, status, data
local data_offset = 0
local response = {}
local pos = 0
local parms = {}
data = string.pack("Bx", COMMAND.FPGetSrvParms)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet()
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
data = response:getPacketData()
parms.server_time, parms.vol_count, pos = string.unpack(">I4B", data)
parms.volumes = {}
for i=1, parms.vol_count do
local volume_name
-- pos+1 to skip over the volume bitmap
volume_name, pos = string.unpack("s1", data, pos + 1)
table.insert(parms.volumes, string.format("%s", volume_name) )
end
response:setResult(parms)
return response
end,
--- Sends an FPLogin request to the server and handles the response
--
-- This function currently only supports the 3.1 through 3.3 protocol versions
-- It currently supports the following authentication methods:
-- o No User Authent
-- o DHCAST128
--
-- The DHCAST128 UAM should work against most servers even though it's
-- superceded by the DHX2 UAM.
--
-- @param afp_version string (AFP3.3|AFP3.2|AFP3.1)
-- @param uam string containing authentication information
-- @return Response object
fp_login = function( self, afp_version, uam, username, password, options )
local packet, status, data
local data_offset = 0
local status, response
if not HAVE_SSL then
response = Response:new()
response:setErrorMessage("OpenSSL not available, aborting ...")
return response
end
-- currently we only support AFP3.3
if afp_version == nil or ( afp_version ~= "AFP3.3" and afp_version ~= "AFP3.2" and afp_version ~= "AFP3.1" ) then
response = Response:new()
response:setErrorMessage("Incorrect AFP version")
return response
end
if ( uam == "No User Authent" ) then
data = string.pack( "Bs1s1", COMMAND.FPLogin, afp_version, uam )
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet( )
elseif( uam == "DHCAST128" ) then
local dhx_s2civ, dhx_c2civ = 'CJalbert', 'LWallace'
local p, g, Ra, Ma, Mb, K, nonce
local EncData, PlainText, K_bin, auth_response
local Id
local username = username or ""
local password = password or ""
username = username .. string.rep('\0', (#username + 1) % 2)
p = openssl.bignum_hex2bn("BA2873DFB06057D43F2024744CEEE75B")
g = openssl.bignum_dec2bn("7")
Ra = openssl.bignum_hex2bn("86F6D3C0B0D63E4B11F113A2F9F19E3BBBF803F28D30087A1450536BE979FD42")
Ma = openssl.bignum_mod_exp(g, Ra, p)
data = string.pack( "Bs1s1s1", COMMAND.FPLogin, afp_version, uam, username) .. openssl.bignum_bn2bin(Ma)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet( )
if ( response:getErrorCode() ~= ERROR.FPAuthContinue ) then
return response
end
if ( response.packet.header.length ~= 50 ) then
response:setErrorMessage("LoginContinue packet contained invalid data")
return response
end
Id, Mb, EncData = string.unpack(">I2c16c32", response.packet.data )
Mb = openssl.bignum_bin2bn( Mb )
K = openssl.bignum_mod_exp (Mb, Ra, p)
K_bin = openssl.bignum_bn2bin(K)
nonce = openssl.decrypt("cast5-cbc", K_bin, dhx_s2civ, EncData, false ):sub(1,16)
nonce = openssl.bignum_add( openssl.bignum_bin2bn(nonce), openssl.bignum_dec2bn("1") )
PlainText = openssl.bignum_bn2bin(nonce) .. Util.ZeroPad(password, 64)
auth_response = openssl.encrypt( "cast5-cbc", K_bin, dhx_c2civ, PlainText, true)
data = string.pack( ">BBI2", COMMAND.FPLoginCont, 0, Id) .. auth_response
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet( )
if ( response:getErrorCode() ~= ERROR.FPNoErr ) then
return response
end
return response
end
response:setErrorMessage("Unsupported uam: " .. uam or "nil")
return response
end,
-- Terminates sessions and frees server resources established by FPLoginand FPLoginExt.
--
-- @return response object
fp_logout = function( self )
local packet, data, response
local data_offset = 0
data = string.pack("Bx", COMMAND.FPLogout)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet( )
end,
--- Sends an FPOpenVol request to the server and handles the response
--
-- @param bitmap number bitmask of volume information to request
-- @param volume_name string containing the volume name to query
-- @return response object with the following result <code>bitmap</code> and
-- <code>volume_id</code> fields
fp_open_vol = function( self, bitmap, volume_name )
local packet, status, pos, data
local data_offset = 0
local response, volume = {}, {}
data = string.pack(">BxI2s1", COMMAND.FPOpenVol, bitmap, volume_name)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet()
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
volume.bitmap, volume.volume_id, pos = string.unpack(">I2I2", response.packet.data)
response:setResult(volume)
return response
end,
--- Sends an FPGetFileDirParms request to the server and handles the response
--
-- @param volume_id number containing the id of the volume to query
-- @param did number containing the id of the directory to query
-- @param file_bitmap number bitmask of file information to query
-- @param dir_bitmap number bitmask of directory information to query
-- @param path table containing the name and the name encoding type of the directory to query
-- @return response object with the following result <code>file_bitmap</code>, <code>dir_bitmap</code>,
-- <code>file_type</code> and (<code>dir<code> or <code>file</code> tables) depending on whether
-- <code>did</code> is a file or directory
fp_get_file_dir_parms = function( self, volume_id, did, file_bitmap, dir_bitmap, path )
local packet, status, data
local data_offset = 0
local response, parms = {}, {}
local pos
if ( did == nil ) then
response = Response:new()
response:setErrorMessage("No Directory Id supplied")
return response
end
if ( volume_id == nil ) then
response = Response:new()
response:setErrorMessage("No Volume Id supplied")
return response
end
data = string.pack(">BxI2I4I2I2", COMMAND.FPGetFileDirParams, volume_id, did, file_bitmap, dir_bitmap)
.. encode_path(path)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet()
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
parms.file_bitmap, parms.dir_bitmap, parms.file_type, pos = string.unpack( ">I2I2Bx", response.packet.data )
-- file or dir?
if ( parms.file_type == 0x80 ) then
pos, parms.dir = Util.decode_dir_bitmap( parms.dir_bitmap, response.packet.data, pos )
else
-- file
pos, parms.file = Util.decode_file_bitmap( parms.file_bitmap, response.packet.data, pos )
end
response:setResult(parms)
return response
end,
--- Sends an FPEnumerateExt2 request to the server and handles the response
--
-- @param volume_id number containing the id of the volume to query
-- @param did number containing the id of the directory to query
-- @param file_bitmap number bitmask of file information to query
-- @param dir_bitmap number bitmask of directory information to query
-- @param req_count number
-- @param start_index number
-- @param reply_size number
-- @param path table containing the name and the name encoding type of the directory to query
-- @return response object with the following result set to a table of tables containing
-- <code>file_bitmap</code>, <code>dir_bitmap</code>, <code>req_count</code> fields
fp_enumerate_ext2 = function( self, volume_id, did, file_bitmap, dir_bitmap, req_count, start_index, reply_size, path )
local packet, pos, status
local data_offset = 0
local response,records = {}, {}
local data = string.pack( ">BxI2I4I2I2", COMMAND.FPEnumerateExt2, volume_id, did, file_bitmap, dir_bitmap )
.. string.pack( ">I2I4I4", req_count, start_index, reply_size)
.. encode_path(path)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet( )
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
file_bitmap, dir_bitmap, req_count, pos = string.unpack(">I2I2I2", response.packet.data)
records = {}
for i=1, req_count do
local record = {}
local len, _, ftype
len, ftype, pos = string.unpack(">I2Bx", response.packet.data, pos)
if ( ftype == 0x80 ) then
_, record = Util.decode_dir_bitmap( dir_bitmap, response.packet.data, pos )
else
-- file
_, record = Util.decode_file_bitmap( file_bitmap, response.packet.data, pos )
end
if ( len % 2 ) ~= 0 then
len = len + 1
end
pos = pos + ( len - 4 )
record.type = ftype
table.insert(records, record)
end
response:setResult(records)
return response
end,
--- Sends an FPOpenFork request to the server and handles the response
--
-- @param flag number
-- @param volume_id number containing the id of the volume to query
-- @param did number containing the id of the directory to query
-- @param file_bitmap number bitmask of file information to query
-- @param access_mode number containing bitmask of options from <code>ACCESS_MODE</code>
-- @param path string containing the name of the directory to query
-- @return response object with the following result contents <code>file_bitmap</code> and <code>fork_id</code>
fp_open_fork = function( self, flag, volume_id, did, file_bitmap, access_mode, path )
local packet
local data_offset = 0
local response, fork = {}, {}
local data = string.pack( ">BBI2I4I2I2", COMMAND.FPOpenFork, flag, volume_id, did, file_bitmap, access_mode )
.. encode_path(path)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet()
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
fork.file_bitmap, fork.fork_id = string.unpack(">I2I2", response.packet.data)
response:setResult(fork)
return response
end,
--- FPCloseFork
--
-- @param fork number containing the fork to close
-- @return response object
fp_close_fork = function( self, fork )
local packet
local data_offset = 0
local response = {}
local data = string.pack( ">BxI2", COMMAND.FPCloseFork, fork )
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet( )
end,
--- FPCreateDir
--
-- @param vol_id number containing the volume id
-- @param dir_id number containing the directory id
-- @param path table containing the name and name encoding type of the directory to query
-- @return response object
fp_create_dir = function( self, vol_id, dir_id, path )
local packet
local data_offset = 0
local response = {}
local data = string.pack( ">BxI2I4", COMMAND.FPCreateDir, vol_id, dir_id)
.. encode_path(path)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet( )
end,
--- Sends an FPCloseVol request to the server and handles the response
--
-- @param volume_id number containing the id of the volume to close
-- @return response object
fp_close_vol = function( self, volume_id )
local packet
local data_offset = 0
local response = {}
local data = string.pack( ">BxI2", COMMAND.FPCloseVol, volume_id )
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet( )
end,
--- FPReadExt
--
-- @param fork number containing the open fork
-- @param offset number containing the offset from where writing should start. Negative value indicates offset from the end of the fork
-- @param count number containing the number of bytes to be written
-- @return response object
fp_read_ext = function( self, fork, offset, count )
local packet, response
local data_offset = 0
local block_size = 1024
local data = string.pack( ">BxI2I8I8", COMMAND.FPReadExt, fork, offset, count )
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet( )
if ( response:getErrorCode() == ERROR.FPEOFErr and response.packet.header.length > 0 ) then
response:setErrorCode( ERROR.FPNoErr )
end
response:setResult( response.packet.data )
return response
end,
--- FPWriteExt
--
-- @param flag number indicates whether Offset is relative to the beginning or end of the fork.
-- @param fork number containing the open fork
-- @param offset number containing the offset from where writing should start. Negative value indicates offset from the end of the fork
-- @param count number containing the number of bytes to be written
-- @param fdata string containing the data to be written
-- @return response object
fp_write_ext = function( self, flag, fork, offset, count, fdata )
local packet
local data_offset = 20
local data
if count > fdata:len() then
local err = Response:new()
err:setErrorMessage("fp_write_ext: Count is greater than the amount of data")
return err
end
if count < 0 then
local err = Response:new()
err:setErrorMessage("fp_write_ext: Count must exceed zero")
return err
end
data = string.pack( ">BBI2I8I8", COMMAND.FPWriteExt, flag, fork, offset, count) .. fdata
packet = self:create_fp_packet( REQUEST.Write, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet( )
end,
--- FPCreateFile
--
-- @param flag number where 0 indicates a soft create and 1 indicates a hard create.
-- @param vol_id number containing the volume id
-- @param did number containing the ancestor directory id
-- @param path string containing the path, including the volume, path and file name
-- @return response object
fp_create_file = function(self, flag, vol_id, did, path )
local packet
local data_offset = 0
local data = string.pack(">BBI2I4", COMMAND.FPCreateFile, flag, vol_id, did)
.. encode_path(path)
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
return self:read_fp_packet()
end,
--- FPMapId
--
-- @param subfunc number containing the subfunction to call
-- @param id number containing th id to translate
-- @return response object with the id in the <code>result</code> field
fp_map_id = function( self, subfunc, id )
local packet, response
local data_offset = 0
local data = string.pack( "BB", COMMAND.FPMapId, subfunc )
if ( subfunc == MAP_ID.UserUUIDToUTF8Name or subfunc == MAP_ID.GroupUUIDToUTF8Name ) then
data = data .. string.pack(">I8", id)
else
data = data .. string.pack(">I4", id)
end
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet( )
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
-- Netatalk returns the name with 1-byte length prefix,
-- Mac OS has a 2-byte (UTF-8) length prefix
local len = string.unpack("B", response.packet.data)
-- if length is zero assume 2-byte length (UTF-8 name)
if len == 0 then
response:setResult(string.unpack(">s2", response.packet.data))
else
response:setResult(string.unpack("s1", response.packet.data ))
end
return response
end,
--- FPMapName
--
-- @param subfunc number containing the subfunction to call
-- @param name string containing name to map
-- @return response object with the mapped name in the <code>result</code> field
fp_map_name = function( self, subfunc, name )
local packet
local data_offset = 0
local data = string.pack(">BBs2", COMMAND.FPMapName, subfunc, name )
local response
packet = self:create_fp_packet( REQUEST.Command, data_offset, data )
self:send_fp_packet( packet )
response = self:read_fp_packet( )
if response:getErrorCode() ~= ERROR.FPNoErr then
return response
end
response:setResult(string.unpack(">I4", response.packet.data))
return response
end,
}
--- The helper class wraps the protocol class and their functions. It contains
-- high-level functions with descriptive names, facilitating the use and
-- minimizing the need to fully understand the AFP low-level protocol details.
Helper = {
--- Creates a new helper object
new = function(self,o,username,password)
local o = {}
setmetatable(o, self)
self.__index = self
o.username = username
o.password = password
return o
end,
--- Connects to the remote server and establishes a new AFP session
--
-- @param host table as received by the action function of the script
-- @param port table as received by the action function of the script
-- @return status boolean
-- @return string containing error message (if status is false)
OpenSession = function( self, host, port )
local status, response
self.socket = net.Socket:new_socket()
status = self.socket:connect(host, port)
if not status then
return false, "Socket connection failed"
end
self.proto = Proto:new( { socket=self.socket} )
response = self.proto:dsi_open_session(self.socket)
if response:getErrorCode() ~= ERROR.FPNoErr then
self.socket:close()
return false, response:getErrorMessage()
end
return true
end,
--- Closes the AFP session and then the socket
--
-- @return status boolean
-- @return string containing error message (if status is false)
CloseSession = function( self )
local status, packet = self.proto:dsi_close_session( )
self.socket:close()
return status, packet
end,
--- Terminates the connection, without closing the AFP session
--
-- @return status (always true)
-- @return string (always "")
Terminate = function( self )
self.socket:close()
return true,""
end,
--- Logs in to an AFP service
--
-- @param username (optional) string containing the username
-- @param password (optional) string containing the user password
-- @param options table containing additional options <code>uam</code>
Login = function( self, username, password, options )
local uam = ( options and options.UAM ) and options.UAM or "DHCAST128"
local response
-- username and password arguments override the ones supplied using the
-- script arguments afp.username and afp.password
local username = username or self.username
local password = password or self.password
if ( username and uam == "DHCAST128" ) then
response = self.proto:fp_login( "AFP3.1", "DHCAST128", username, password )
elseif( username ) then
return false, ("Unsupported UAM: %s"):format(uam)
else
response = self.proto:fp_login( "AFP3.1", "No User Authent" )
end
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
return true, "Success"
end,
--- Logs out from the AFP service
Logout = function(self)
return self.proto:fp_logout()
end,
--- Walks the directory tree specified by <code>str_path</code> and returns the node information
--
-- @param str_path string containing the directory
-- @return status boolean true on success, otherwise false
-- @return item table containing node information <code>DirectoryId</code> and <code>DirectoryName</code>
WalkDirTree = function( self, str_path )
local status, response
local elements = stringaux.strsplit( "/", str_path )
local f_bm = FILE_BITMAP.NodeId + FILE_BITMAP.ParentDirId + FILE_BITMAP.LongName
local d_bm = DIR_BITMAP.NodeId + DIR_BITMAP.ParentDirId + DIR_BITMAP.LongName
local item = { DirectoryId = 2 }
response = self.proto:fp_open_vol( VOL_BITMAP.ID, elements[1] )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
item.VolumeId = response.result.volume_id
item.DirectoryName = str_path
for i=2, #elements do
local path = { type=PATH_TYPE.LongName, name=elements[i] }
response = self.proto:fp_get_file_dir_parms( item.VolumeId, item.DirectoryId, f_bm, d_bm, path )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
item.DirectoryId = response.result.dir.NodeId
item.DirectoryName = response.result.dir.LongName
end
return true, item
end,
--- Reads a file on the AFP server
--
-- @param str_path string containing the AFP sharepoint, path and filename eg. HR/Documents/File.doc
-- @return status boolean true on success, false on failure
-- @return content string containing the file contents
ReadFile = function( self, str_path )
local status, response, fork, content, vol_name
local offset, count, did = 0, 1024, 2
local status, path, vol_id
local p = Util.SplitPath( str_path )
status, response = self:WalkDirTree( p.dir )
if ( not status ) then
return false, response
end
vol_id = response.VolumeId
did = response.DirectoryId
path = { type=PATH_TYPE.LongName, name=p.file }
response = self.proto:fp_open_fork(0, vol_id, did, 0, ACCESS_MODE.Read, path )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
fork = response.result.fork_id
content = ""
while true do
response = self.proto:fp_read_ext( fork, offset, count )
if response:getErrorCode() ~= ERROR.FPNoErr then
break
end
content = content .. response.result
offset = offset + count
end
response = self.proto:fp_close_fork( fork )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
return true, content
end,
--- Writes a file to the AFP server
--
-- @param str_path string containing the AFP sharepoint, path and filename eg. HR/Documents/File.doc
-- @param fdata string containing the data to write to the file
-- @return status boolean true on success, false on failure
-- @return error string containing error message if status is false
WriteFile = function( self, str_path, fdata )
local status, response, fork, content
local offset, count = 1, 1024
local status, vol_id, did, path
local p = Util.SplitPath( str_path )
status, response = self:WalkDirTree( p.dir )
vol_id = response.VolumeId
did = response.DirectoryId
if ( not status ) then
return false, response
end
path = { type=PATH_TYPE.LongName, name=p.file }
status, response = self.proto:fp_create_file( 0, vol_id, did, path )
if not status then
if ( response.header.error_code ~= ERROR.FPObjectExists ) then
return false, response.header.error_msg
end
end
response = self.proto:fp_open_fork( 0, vol_id, did, 0, ACCESS_MODE.Write, path )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
fork = response.result.fork_id
response = self.proto:fp_write_ext( 0, fork, 0, fdata:len(), fdata )
return true, nil
end,
--- Maps a user id (uid) to a user name
--
-- @param uid number containing the uid to resolve
-- @return status boolean true on success, false on failure
-- @return username string on success
-- error string on failure
UIDToName = function( self, uid )
local response = self.proto:fp_map_id( MAP_ID.UserIDToName, uid )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
return true, response.result
end,
--- Maps a group id (gid) to group name
--
-- @param gid number containing the gid to lookup
-- @return status boolean true on success, false on failure
-- @return groupname string on success
-- error string on failure
GIDToName = function( self, gid )
local response = self.proto:fp_map_id( MAP_ID.GroupIDToName, gid )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
return true, response.result
end,
--- Maps a username to a UID
--
-- @param name string containing the username to map to an UID
-- @return status boolean true on success, false on failure
-- @return UID number on success
-- error string on failure
NameToUID = function( self, name )
local response = self.proto:fp_map_name( MAP_NAME.NameToUserID, name )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
return true, response.result
end,
--- List the contents of a directory
--
-- @param str_path string containing the sharepoint and directory names
-- @param options table options containing zero or more of the options
-- <code>max_depth</code> and <code>dironly</code>
-- @param depth number containing the current depth (used when called recursively)
-- @param parent table containing information about the parent object (used when called recursively)
-- @return status boolean true on success, false on failure
-- @return dir table containing a table for each directory item with the following:
-- <code>type</code>, <code>name</code>, <code>id</code>,
-- <code>fsize</code>, <code>uid</code>, <code>gid</code>,
-- <code>privs</code>, <code>create</code>, <code>modify</code>
Dir = function( self, str_path, options, depth, parent )
local status, result
local depth = depth or 1
local options = options or { max_depth = 1 }
local response, records
local f_bm = FILE_BITMAP.NodeId | FILE_BITMAP.ParentDirId
| FILE_BITMAP.LongName | FILE_BITMAP.UnixPrivileges
| FILE_BITMAP.CreationDate | FILE_BITMAP.ModificationDate
| FILE_BITMAP.ExtendedDataForkSize
local d_bm = DIR_BITMAP.NodeId | DIR_BITMAP.ParentDirId
| DIR_BITMAP.LongName | DIR_BITMAP.UnixPrivileges
| DIR_BITMAP.CreationDate | DIR_BITMAP.ModificationDate
local TYPE_DIR = 0x80
if ( parent == nil ) then
status, response = self:WalkDirTree( str_path )
if ( not status ) then
return false, response
end
parent = {}
parent.vol_id = response.VolumeId
parent.did = response.DirectoryId
parent.dir_name = response.DirectoryName or ""
parent.out_tbl = {}
end
if ( options and options.max_depth and options.max_depth > 0 and options.max_depth < depth ) then
return false, "Max Depth Reached"
end
local path = { type=PATH_TYPE.LongName, name="" }
response = self.proto:fp_enumerate_ext2( parent.vol_id, parent.did, f_bm, d_bm, 1000, 1, 1000 * 300, path)
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
records = response.result or {}
local dir_items = {}
for _, record in ipairs( records ) do
local isdir = record.type == TYPE_DIR
-- Skip non-directories if option "dironly" is set
if isdir or not options.dironly then
local item = {type = record.type,
name = record.LongName,
id = record.NodeId,
fsize = record.ExtendedDataForkSize or 0}
local privs = (record.UnixPrivileges or {}).ua_permissions
if privs then
item.uid = record.UnixPrivileges.uid
item.gid = record.UnixPrivileges.gid
item.privs = (isdir and "d" or "-") .. Util.decode_unix_privs(privs)
end
item.create = Util.time_to_string(record.CreationDate)
item.modify = Util.time_to_string(record.ModificationDate)
table.insert( dir_items, item )
end
if isdir then
self:Dir("", options, depth + 1, { vol_id = parent.vol_id, did=record.NodeId, dir_name=record.LongName, out_tbl=dir_items} )
end
end
table.insert( parent.out_tbl, dir_items )
return true, parent.out_tbl
end,
--- Displays a directory tree
--
-- @param str_path string containing the sharepoint and the directory
-- @param options table options containing zero or more of the options
-- <code>max_depth</code> and <code>dironly</code>
-- @return dirtree table containing the directories
DirTree = function( self, str_path, options )
local options = options or {}
options.dironly = true
return self:Dir( str_path, options )
end,
--- List the AFP sharepoints
--
-- @return volumes table containing the sharepoints
ListShares = function( self )
local response
response = self.proto:fp_get_srvr_parms( )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
return true, response.result.volumes
end,
--- Determine the sharepoint permissions
--
-- @param vol_name string containing the name of the volume
-- @return status boolean true on success, false on failure
-- @return acls table containing the volume acls as returned by <code>acls_to_long_string</code>
GetSharePermissions = function( self, vol_name )
local status, response, acls
response = self.proto:fp_open_vol( VOL_BITMAP.ID, vol_name )
if response:getErrorCode() == ERROR.FPNoErr then
local vol_id = response.result.volume_id
local path = { type = PATH_TYPE.LongName, name = "" }
response = self.proto:fp_get_file_dir_parms( vol_id, 2, FILE_BITMAP.ALL, DIR_BITMAP.ALL, path )
if response:getErrorCode() == ERROR.FPNoErr then
if ( response.result.dir and response.result.dir.AccessRights ) then
acls = Util.acls_to_long_string(response.result.dir.AccessRights)
acls.name = nil
end
end
self.proto:fp_close_vol( vol_id )
end
return true, acls
end,
--- Gets the Unix permissions of a file
-- @param vol_name string containing the name of the volume
-- @param str_path string containing the name of the file
-- @return status true on success, false on failure
-- @return acls table (on success) containing the following fields
-- <code>uid</code> - a numeric user identifier
-- <code>gid</code> - a numeric group identifier
-- <code>privs</code> - a string value representing the permissions
-- eg: drwx------
-- @return err string (on failure) containing the error message
GetFileUnixPermissions = function(self, vol_name, str_path)
local response = self.proto:fp_open_vol( VOL_BITMAP.ID, vol_name )
if ( response:getErrorCode() ~= ERROR.FPNoErr ) then
return false, response:getErrorMessage()
end
local vol_id = response.result.volume_id
local path = { type = PATH_TYPE.LongName, name = str_path }
response = self.proto:fp_get_file_dir_parms( vol_id, 2, FILE_BITMAP.UnixPrivileges, DIR_BITMAP.UnixPrivileges, path )
if ( response:getErrorCode() ~= ERROR.FPNoErr ) then
return false, response:getErrorMessage()
end
local item = response.result.file or response.result.dir
local item_type = ( response.result.file ) and "-" or "d"
local privs = item.UnixPrivileges and item.UnixPrivileges.ua_permissions
if ( privs ) then
local uid = item.UnixPrivileges.uid
local gid = item.UnixPrivileges.gid
local str_privs = item_type .. Util.decode_unix_privs(privs)
return true, { uid = uid, gid = gid, privs = str_privs }
end
end,
--- Gets the Unix permissions of a file
-- @param vol_name string containing the name of the volume
-- @param str_path string containing the name of the file
-- @return status true on success, false on failure
-- @return size containing the size of the file in bytes
-- @return err string (on failure) containing the error message
GetFileSize = function( self, vol_name, str_path )
local response = self.proto:fp_open_vol( VOL_BITMAP.ID, vol_name )
if ( response:getErrorCode() ~= ERROR.FPNoErr ) then
return false, response:getErrorMessage()
end
local vol_id = response.result.volume_id
local path = { type = PATH_TYPE.LongName, name = str_path }
response = self.proto:fp_get_file_dir_parms( vol_id, 2, FILE_BITMAP.ExtendedDataForkSize, 0, path )
if ( response:getErrorCode() ~= ERROR.FPNoErr ) then
return false, response:getErrorMessage()
end
return true, response.result.file and response.result.file.ExtendedDataForkSize or 0
end,
--- Returns the creation, modification and backup dates of a file
-- @param vol_name string containing the name of the volume
-- @param str_path string containing the name of the file
-- @return status true on success, false on failure
-- @return dates table containing the following fields:
-- <code>create</code> - Creation date of the file
-- <code>modify</code> - Modification date of the file
-- <code>backup</code> - Date of last backup
-- @return err string (on failure) containing the error message
GetFileDates = function( self, vol_name, str_path )
local response = self.proto:fp_open_vol( VOL_BITMAP.ID, vol_name )
if ( response:getErrorCode() ~= ERROR.FPNoErr ) then
return false, response:getErrorMessage()
end
local vol_id = response.result.volume_id
local path = { type = PATH_TYPE.LongName, name = str_path }
local f_bm = FILE_BITMAP.CreationDate + FILE_BITMAP.ModificationDate + FILE_BITMAP.BackupDate
local d_bm = DIR_BITMAP.CreationDate + DIR_BITMAP.ModificationDate + DIR_BITMAP.BackupDate
response = self.proto:fp_get_file_dir_parms( vol_id, 2, f_bm, d_bm, path )
if ( response:getErrorCode() ~= ERROR.FPNoErr ) then
return false, response:getErrorMessage()
end
local item = response.result.file or response.result.dir
local create = Util.time_to_string(item.CreationDate)
local backup = Util.time_to_string(item.BackupDate)
local modify = Util.time_to_string(item.ModificationDate)
return true, { create = create, backup = backup, modify = modify }
end,
--- Creates a new directory on the AFP sharepoint
--
-- @param str_path containing the sharepoint and the directory
-- @return status boolean true on success, false on failure
-- @return dirId number containing the new directory id
CreateDir = function( self, str_path )
local status, response, vol_id, did
local p = Util.SplitPath( str_path )
local path = { type=PATH_TYPE.LongName, name=p.file }
status, response = self:WalkDirTree( p.dir )
if not status then
return false, response
end
response = self.proto:fp_create_dir( response.VolumeId, response.DirectoryId, path )
if response:getErrorCode() ~= ERROR.FPNoErr then
return false, response:getErrorMessage()
end
return true, response
end,
}
--- Util class, containing some static functions used by Helper and Proto
Util =
{
--- Pads a string with zeroes
--
-- @param str string containing the string to be padded
-- @param len number containing the length of the new string
-- @return str string containing the new string
ZeroPad = function( str, len )
return str .. string.rep('\0', len - str:len())
end,
--- Splits a path into two pieces, directory and file
--
-- @param str_path string containing the path to split
-- @return dir table containing <code>dir</code> and <code>file</code>
SplitPath = function( str_path )
local elements = stringaux.strsplit("/", str_path)
local dir, file = "", ""
if #elements < 2 then
return nil
end
file = elements[#elements]
table.remove( elements, #elements )
dir = table.concat( elements, "/" )
return { ['dir']=dir, ['file']=file }
end,
--- Converts a group bitmask of Search, Read and Write to table
--
-- @param acls number containing bitmasked acls
-- @return table of ACLs
acl_group_to_long_string = function(acls)
local acl_table = {}
if ( acls & ACLS.OwnerSearch ) == ACLS.OwnerSearch then
table.insert( acl_table, "Search")
end
if ( acls & ACLS.OwnerRead ) == ACLS.OwnerRead then
table.insert( acl_table, "Read")
end
if ( acls & ACLS.OwnerWrite ) == ACLS.OwnerWrite then
table.insert( acl_table, "Write")
end
return acl_table
end,
--- Converts a numeric acl to string
--
-- @param acls number containing acls as received from <code>fp_get_file_dir_parms</code>
-- @return table of long ACLs
acls_to_long_string = function( acls )
local owner = Util.acl_group_to_long_string( ( acls & 255 ) )
local group = Util.acl_group_to_long_string( ( (acls >> 8) & 255 ) )
local everyone = Util.acl_group_to_long_string( ( (acls >> 16) & 255 ) )
local user = Util.acl_group_to_long_string( ( (acls >> 24) & 255 ) )
local blank = ( acls & ACLS.BlankAccess ) == ACLS.BlankAccess and "Blank" or nil
local isowner = ( acls & ACLS.UserIsOwner ) == ACLS.UserIsOwner and "IsOwner" or nil
local options = {}
if blank then
table.insert(options, "Blank")
end
if isowner then
table.insert(options, "IsOwner")
end
local acls_tbl = {}
table.insert( acls_tbl, string.format( "Owner: %s", table.concat(owner, ",") ) )
table.insert( acls_tbl, string.format( "Group: %s", table.concat(group, ",") ) )
table.insert( acls_tbl, string.format( "Everyone: %s", table.concat(everyone, ",") ) )
table.insert( acls_tbl, string.format( "User: %s", table.concat(user, ",") ) )
if #options > 0 then
table.insert( acls_tbl, string.format( "Options: %s", table.concat(options, ",") ) )
end
return acls_tbl
end,
--- Converts AFP file timestamp to a standard text format
--
-- @param timestamp value returned by FPEnumerateExt2 or FPGetFileDirParms
-- @return string representing the timestamp
time_to_string = function (timestamp)
return timestamp and datetime.format_timestamp(timestamp + TIME_OFFSET) or nil
end,
--- Decodes the UnixPrivileges.ua_permissions value
--
-- @param privs number containing the UnixPrivileges.ua_permissions value
-- @return string containing the ACL characters
decode_unix_privs = function( privs )
local owner = ( ( privs & ACLS.OwnerRead ) == ACLS.OwnerRead ) and "r" or "-"
owner = owner .. (( ( privs & ACLS.OwnerWrite ) == ACLS.OwnerWrite ) and "w" or "-")
owner = owner .. (( ( privs & ACLS.OwnerSearch ) == ACLS.OwnerSearch ) and "x" or "-")
local group = ( ( privs & ACLS.GroupRead ) == ACLS.GroupRead ) and "r" or "-"
group = group .. (( ( privs & ACLS.GroupWrite ) == ACLS.GroupWrite ) and "w" or "-")
group = group .. (( ( privs & ACLS.GroupSearch ) == ACLS.GroupSearch ) and "x" or "-")
local other = ( ( privs & ACLS.EveryoneRead ) == ACLS.EveryoneRead ) and "r" or "-"
other = other .. (( ( privs & ACLS.EveryoneWrite ) == ACLS.EveryoneWrite ) and "w" or "-")
other = other .. (( ( privs & ACLS.EveryoneSearch ) == ACLS.EveryoneSearch ) and "x" or "-")
return owner .. group .. other
end,
--- Decodes a file bitmap
--
-- @param bitmap number containing the bitmap
-- @param data string containing the data to be decoded
-- @param pos number containing the offset into data
-- @return pos number containing the new offset after decoding
-- @return file table containing the decoded values
decode_file_bitmap = function( bitmap, data, pos )
local origpos = pos
local file = {}
if ( ( bitmap & FILE_BITMAP.Attributes ) == FILE_BITMAP.Attributes ) then
file.Attributes, pos = string.unpack(">I2", data, pos )
end
if ( ( bitmap & FILE_BITMAP.ParentDirId ) == FILE_BITMAP.ParentDirId ) then
file.ParentDirId, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & FILE_BITMAP.CreationDate ) == FILE_BITMAP.CreationDate ) then
file.CreationDate, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & FILE_BITMAP.ModificationDate ) == FILE_BITMAP.ModificationDate ) then
file.ModificationDate, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & FILE_BITMAP.BackupDate ) == FILE_BITMAP.BackupDate ) then
file.BackupDate, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & FILE_BITMAP.FinderInfo ) == FILE_BITMAP.FinderInfo ) then
file.FinderInfo, pos = string.unpack("c32", data, pos )
end
if ( ( bitmap & FILE_BITMAP.LongName ) == FILE_BITMAP.LongName ) then
local offset
offset, pos = string.unpack(">I2", data, pos)
if offset > 0 then
file.LongName = string.unpack("s1", data, origpos + offset)
end
end
if ( ( bitmap & FILE_BITMAP.ShortName ) == FILE_BITMAP.ShortName ) then
local offset
offset, pos = string.unpack(">I2", data, pos)
if offset > 0 then
file.ShortName = string.unpack("s1", data, origpos + offset)
end
end
if ( ( bitmap & FILE_BITMAP.NodeId ) == FILE_BITMAP.NodeId ) then
file.NodeId, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & FILE_BITMAP.DataForkSize ) == FILE_BITMAP.DataForkSize ) then
file.DataForkSize, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & FILE_BITMAP.ResourceForkSize ) == FILE_BITMAP.ResourceForkSize ) then
file.ResourceForkSize, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & FILE_BITMAP.ExtendedDataForkSize ) == FILE_BITMAP.ExtendedDataForkSize ) then
file.ExtendedDataForkSize, pos = string.unpack(">I8", data, pos )
end
if ( ( bitmap & FILE_BITMAP.LaunchLimit ) == FILE_BITMAP.LaunchLimit ) then
-- should not be set as it's deprecated according to:
-- http://developer.apple.com/mac/library/documentation/Networking/Reference/AFP_Reference/Reference/reference.html#//apple_ref/doc/c_ref/kFPLaunchLimitBit
end
if ( ( bitmap & FILE_BITMAP.UTF8Name ) == FILE_BITMAP.UTF8Name ) then
local offset
offset, pos = string.unpack(">I2", data, pos)
if offset > 0 then
-- +4 to skip over the encoding hint
file.UTF8Name = string.unpack(">s2", data, origpos + offset + 4)
end
-- Skip over the trailing pad
pos = pos + 4
end
if ( ( bitmap & FILE_BITMAP.ExtendedResourceForkSize ) == FILE_BITMAP.ExtendedResourceForkSize ) then
file.ExtendedResourceForkSize, pos = string.unpack(">I8", data, pos )
end
if ( ( bitmap & FILE_BITMAP.UnixPrivileges ) == FILE_BITMAP.UnixPrivileges ) then
local unixprivs = {}
unixprivs.uid, unixprivs.gid, unixprivs.permissions, unixprivs.ua_permissions, pos = string.unpack(">I4I4I4I4", data, pos)
file.UnixPrivileges = unixprivs
end
return pos, file
end,
--- Decodes a directory bitmap
--
-- @param bitmap number containing the bitmap
-- @param data string containing the data to be decoded
-- @param pos number containing the offset into data
-- @return pos number containing the new offset after decoding
-- @return dir table containing the decoded values
decode_dir_bitmap = function( bitmap, data, pos )
local origpos = pos
local dir = {}
if ( ( bitmap & DIR_BITMAP.Attributes ) == DIR_BITMAP.Attributes ) then
dir.Attributes, pos = string.unpack(">I2", data, pos)
end
if ( ( bitmap & DIR_BITMAP.ParentDirId ) == DIR_BITMAP.ParentDirId ) then
dir.ParentDirId, pos = string.unpack(">I4", data, pos)
end
if ( ( bitmap & DIR_BITMAP.CreationDate ) == DIR_BITMAP.CreationDate ) then
dir.CreationDate, pos = string.unpack(">I4", data, pos)
end
if ( ( bitmap & DIR_BITMAP.ModificationDate ) == DIR_BITMAP.ModificationDate ) then
dir.ModificationDate, pos = string.unpack(">I4", data, pos)
end
if ( ( bitmap & DIR_BITMAP.BackupDate ) == DIR_BITMAP.BackupDate ) then
dir.BackupDate, pos = string.unpack(">I4", data, pos)
end
if ( ( bitmap & DIR_BITMAP.FinderInfo ) == DIR_BITMAP.FinderInfo ) then
dir.FinderInfo, pos = string.unpack("c32", data, pos)
end
if ( ( bitmap & DIR_BITMAP.LongName ) == DIR_BITMAP.LongName ) then
local offset
offset, pos = string.unpack(">I2", data, pos)
-- TODO: This really needs to be addressed someway
-- Barely, never, ever happens, which makes it difficult to pin down
-- http://developer.apple.com/mac/library/documentation/Networking/Reference/AFP_Reference/Reference/reference.html#//apple_ref/doc/uid/TP40003548-CH3-CHDBEHBG
-- [nnposter, 8/1/2020] URL above not available. Offset below (pos+4)
-- seems illogical, as it partially covers two separate fields: bottom
-- half of the file ID and the entire offspring count.
-- Disabled the hack, as it interfered with valid cases
--[[
local justkidding = string.unpack(">I4", data, pos + 4)
if ( justkidding ~= 0 ) then
offset = 5
end
]]
if offset > 0 then
dir.LongName = string.unpack("s1", data, origpos + offset)
end
end
if ( ( bitmap & DIR_BITMAP.ShortName ) == DIR_BITMAP.ShortName ) then
local offset
offset, pos = string.unpack(">I2", data, pos)
if offset > 0 then
dir.ShortName = string.unpack("s1", data, origpos + offset)
end
end
if ( ( bitmap & DIR_BITMAP.NodeId ) == DIR_BITMAP.NodeId ) then
dir.NodeId, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & DIR_BITMAP.OffspringCount ) == DIR_BITMAP.OffspringCount ) then
dir.OffspringCount, pos = string.unpack(">I2", data, pos )
end
if ( ( bitmap & DIR_BITMAP.OwnerId ) == DIR_BITMAP.OwnerId ) then
dir.OwnerId, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & DIR_BITMAP.GroupId ) == DIR_BITMAP.GroupId ) then
dir.GroupId, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & DIR_BITMAP.AccessRights ) == DIR_BITMAP.AccessRights ) then
dir.AccessRights, pos = string.unpack(">I4", data, pos )
end
if ( ( bitmap & DIR_BITMAP.UTF8Name ) == DIR_BITMAP.UTF8Name ) then
local offset
offset, pos = string.unpack(">I2", data, pos)
if offset > 0 then
-- +4 to skip over the encoding hint
dir.UTF8Name = string.unpack(">s2", data, origpos + offset + 4)
end
-- Skip over the trailing pad
pos = pos + 4
end
if ( ( bitmap & DIR_BITMAP.UnixPrivileges ) == DIR_BITMAP.UnixPrivileges ) then
local unixprivs = {}
unixprivs.uid, unixprivs.gid, unixprivs.permissions, unixprivs.ua_permissions, pos = string.unpack(">I4I4I4I4", data, pos)
dir.UnixPrivileges = unixprivs
end
return pos, dir
end,
}
return _ENV;