Developing applications that use the F-Response Flexdisk

Transcription

1 Getting started Access to the Flexdisk API is available from any platform capable of issuing HTTPS URL based web queries, including all mobile device platforms. Accessing the Flexdisk is very simple, it was designed to be straight forward and universally accessible from most web friendly programming environments. API Overview The F-Response Flexdisk API consists of two main parts, flexd and hscsi. Flexdisk API Overview /flexd? Explore, Read, Extract Provides access to file system structures and meta data. /hscsi? Read Provides read access to physical device (memory) raw data. Authentication Access to the Flexdisk is protected using standard HTTP Basic Authentication over SSL. All web queries are authenticated using this model. Data Encoding Unless otherwise indicated the Flexdisk API makes use of the Javascript Object Notation (JSON) data encoding format. JSON is well documented in the industry and there are numerous libraries capable of manipulating JSON encoded content. More details on JSON and consuming JSON in your applications is available at Developing applications that use the F-Response Flexdisk We are very excited that you ve chosen to develop applications that use the patented F-Response Flexdisk technology. To that end we would love to hear about your application, if it s available for purchase or open source we d be happy to link to it from our site and give you access to the F-Response Flexdisk Enabled logo for use on your website and materials. <LOGO FORTHCOMING> 1

2 Flexdisk Web Request and Response Values Flexdisk Web Query Request Arguments 1 Request Meaning Values Notes Argument tgt Target vol-c,rdisk0,etc Indicates the target name as provided by the main Flexdisk handler. enc Encoding json,csv,html Instructs the Flexdisk handler to return the output in one of three potential encoding formats, JSON, CSV, or HTML. Default is HTML unless otherwise configured node File or <numeric> Indicates the desired node by numeric value. Directory Node value type Response value type data,meta,read Indicates the desired value type, data for accessing the entire file, meta for file metadata, or read for name offset len File or Directory Name File Offset to start at Length of file content to obtain <numeric> <numeric> reading from a select location within a file. Indicates the name of the file or directory requested. Valid only for Read Operations (type=read), value in bytes. Valid only for Read Operations (type=read), value in bytes. Flexdisk Web Query Response Values (JSON Encoded Responses Only) Response Meaning Values Notes name Name of the type uri Type of URL used to access the specific <URL> Indicates the name of the, depending on usage it may be a file, directory, or a disk/device. Indicates the type of the. Examples include ntfs for file system type, or dir for directory node type. Provides a URL to access the (data or explore) depending on the. node Node value <numeric> Numeric identifier for a given. sectorsize Size of a <numeric> Indicates the Sector Size of a target device. single sector volsize Size of the <numeric> Indicates the size of the target device. device atime Access <unix time> Indicates the last access time in unix time. atime_hires Access <win32 time> Indicates the last access time in win32 time, where available. 1 Unless otherwise noted all URL queries use the /flexd? preface. 2

3 ctime Change <unix time> Indicates the changed time on Ext2/3/4 and the Entry Modified on NTFS. ctime_hires Change <win32 time> Indicates the changed time on Ext2/3/4 and the Entry Modified on NTFS in win32 time. crtime Create <unix time> Indicates the Created time on FAT and NTFS. crtime_hires Create <win32 time> Indicates the Created time on FAT and NTFS in win32 time. mtime Modified <unix time> Indicates the Modified time on Ext2/3/4, the written mtime_hires Modified <win32 time> time on FAT, and the File Modified on NTFS. Indicates the Modified time on Ext2/3/4, the written time on FAT, and the File Modified on NTFS in Win32 time. bkuptime Backup <unix time> Indicates the Backup time on HFS. (OSX) dtime Deleted <unix time> Indicates the Deleted time on Ext2/3. (Linux) host Hostname Hostname of the target machine date Date <datetime> Date/ of the completed query response. 3

4 Flexdisk Sample Queries Obtain a listing of all Flexdisks on the target computer (JSON encoded) : "response": "host": "<HOST>", "date": "Mon, 04 Apr :49:20 Eastern Daylight ", "name": "vol-c", "type": "ntfs", "uri": " "sectorsize": "4096", "volsize": " " ] Obtain a listing of the content for the root of a provided Flexdisk (JSON encoded) "response": "host": "WIN7-DEVEL", "date": "Wed, 01 Jun :41:43 Eastern Daylight ", "name": "Documents and Settings", "size": "48", "type": "dir", "state": "alloc", "uri": " C&node=13688&enc=json&name=Documents and Settings", "node": "13688", "atime": " ", "atime_hires": " ", "ctime": " ", "ctime_hires": " ", "crtime": " ", "crtime_hires": " ", "mtime": " ", "mtime_hires": " ", "bkuptime": "0", "dtime": "0", Extract a given allocated or unallocated file based on the node. Chunked encoding streaming file content from provided node. 4

5 Obtain a listing of the content for a given node(directory) of selected Flexdisk (JSON encoded) "response": "host": "WIN7-DEVEL", "date": "Wed, 01 Jun :51:28 Eastern Daylight ", "name": "..", "size": "192", "type": "dir", "state": "alloc", "uri": " C&node=5&enc=json&name=..", "node": "5", "atime": " ", "ctime": " ", "crtime": " ", "mtime": " ", "bkuptime": "0", "dtime": "0", "name": "Administrator", "size": "256", "type": "dir", "state": "alloc", "uri": " C&node=49&enc=json&name=Administrator", "node": "49", "atime": " ", "ctime": " ", "crtime": " ", "mtime": " ", "bkuptime": "0", "dtime": "0", Read from a given location in a node(file Nodes) en=<len> Chunked encoding streaming file content from provided node at the requested offset. 5

6 hscsi Web Request and Response Values hscsi Web Query Request Arguments 2 Request Meaning Values Notes Argument tgt Target fdisk-0, 1, 2, etc Indicates the target name as provided by the main hscsi handler. offset File Offset to start at <numeric> Valid only for Read Operations (type=read), value in blocks. len Length of file content to obtain <numeric> Valid only for Read Operations (type=read), value is number of blocks. Total size may not be larger than bytes (Ex. 1 Block = 512 bytes, max read is 126 blocks) hscsi Web Query Response Values (JSON Encoded Responses Only) Response Meaning Values Notes name Name of the type uri Type of URL used to access the specific <URL> Indicates the name of the, depending on usage it may be a file, directory, or a disk/device. Indicates the type of the. Examples include disk, pmem, etc. Provides a URL to access the (data or explore) depending on the. blocksz Size of a single sector <numeric> Indicates the block size (sector size) of a target hscsi device. blockc Count of <numeric> Indicates the total block(sector) count. sectors disksize Size of the <unix time> Indicates the total device size in bytes. disk in bytes host Hostname Hostname of the target machine date Date <datetime> Date/ of the completed query response. 2 Unless otherwise noted all URL queries use the /hscsi? preface. 6

7 hscsi Sample Queries Obtain a listing of all hscsi targets on the target computer (JSON encoded) : "response": "host": "WIN7-DEVEL", "date": "Tue, 31 May :29:24 Eastern Daylight ", "name": "fdisk-0", "type": "disk", "uri": " "blocksz": "512", "blockc": " ", "disksize": " " ] Read from a given location in a hscsi target (Raw Device) Chunked encoding streaming raw device content from hscsi target at the requested offset. 7