mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Import/Export support for IOU nvrams.
This commit is contained in:
grossmj committed
1 parent
e63b9ff0e6
commit
ca331ae2a5
11 files changed
+826
-116
No files matched your search
Whitespace-only changes.
@@ -0,0 +1,239 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# To use python v2.7 change the first line to:
|
||||
#!/usr/bin/env python
|
||||
|
||||
# Copyright (C) 2015 Bernhard Ehlers
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# This utility is a stripped down version of dynamips' nvram_export,
|
||||
# ported from C to Python, see https://github.com/GNS3/dynamips
|
||||
# nvram_export is (c) 2013 Flávio J. Saraiva
|
||||
|
||||
"""
|
||||
iou_export exports startup/private configuration from IOU NVRAM file.
|
||||
|
||||
usage: iou_export [-h] NVRAM startup-config [private-config]
|
||||
|
||||
positional arguments:
|
||||
NVRAM NVRAM file
|
||||
startup-config startup configuration
|
||||
private-config private configuration
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import sys
|
||||
from array import array
|
||||
|
||||
|
||||
# Uncompress data in .Z file format.
|
||||
# Ported from dynamips' fs_nvram.c to python
|
||||
# Adapted from 7zip's ZDecoder.cpp, which is licensed under LGPL 2.1.
|
||||
def uncompress_LZC(data):
|
||||
LZC_NUM_BITS_MIN = 9
|
||||
LZC_NUM_BITS_MAX = 16
|
||||
|
||||
in_data = array('B', data)
|
||||
in_len = len(in_data)
|
||||
out_data = array('B')
|
||||
|
||||
if in_len == 0:
|
||||
return out_data.tostring()
|
||||
if in_len < 3:
|
||||
raise ValueError('invalid length')
|
||||
if in_data[0] != 0x1F or in_data[1] != 0x9D:
|
||||
raise ValueError('invalid header')
|
||||
|
||||
maxbits = in_data[2] & 0x1F
|
||||
numItems = 1 << maxbits
|
||||
blockMode = (in_data[2] & 0x80) != 0
|
||||
if maxbits < LZC_NUM_BITS_MIN or maxbits > LZC_NUM_BITS_MAX:
|
||||
raise ValueError('not supported')
|
||||
|
||||
parents = array('H', [0] * numItems)
|
||||
suffixes = array('B', [0] * numItems)
|
||||
stack = array('B', [0] * numItems)
|
||||
|
||||
in_pos = 3
|
||||
numBits = LZC_NUM_BITS_MIN
|
||||
head = 256
|
||||
if blockMode:
|
||||
head += 1
|
||||
|
||||
needPrev = 0
|
||||
bitPos = 0
|
||||
numBufBits = 0
|
||||
|
||||
parents[256] = 0
|
||||
suffixes[256] = 0
|
||||
|
||||
buf_extend = array('B', [0] * 3)
|
||||
|
||||
while True:
|
||||
# fill buffer, when empty
|
||||
if numBufBits == bitPos:
|
||||
buf_len = min(in_len - in_pos, numBits)
|
||||
buf = in_data[in_pos:in_pos+buf_len] + buf_extend
|
||||
numBufBits = buf_len << 3
|
||||
bitPos = 0
|
||||
in_pos += buf_len
|
||||
|
||||
# extract next symbol
|
||||
bytePos = bitPos >> 3
|
||||
symbol = buf[bytePos] | buf[bytePos + 1] << 8 | buf[bytePos + 2] << 16
|
||||
symbol >>= bitPos & 7
|
||||
symbol &= (1 << numBits) - 1
|
||||
bitPos += numBits
|
||||
|
||||
# check for special conditions: end, bad data, re-initialize dictionary
|
||||
if bitPos > numBufBits:
|
||||
break
|
||||
if symbol >= head:
|
||||
raise ValueError('invalid data')
|
||||
if blockMode and symbol == 256:
|
||||
numBufBits = bitPos = 0
|
||||
numBits = LZC_NUM_BITS_MIN
|
||||
head = 257
|
||||
needPrev = 0
|
||||
continue
|
||||
|
||||
# convert symbol to string
|
||||
cur = symbol
|
||||
i = len(stack)
|
||||
while cur >= 256:
|
||||
i -= 1
|
||||
stack[i] = suffixes[cur]
|
||||
cur = parents[cur]
|
||||
i -= 1
|
||||
stack[i] = cur
|
||||
if needPrev:
|
||||
suffixes[head - 1] = cur
|
||||
if symbol == head - 1:
|
||||
stack[-1] = cur
|
||||
out_data.extend(stack[i:])
|
||||
|
||||
# update parents, check for numBits change
|
||||
if head < numItems:
|
||||
needPrev = 1
|
||||
parents[head] = symbol
|
||||
head += 1
|
||||
if head > (1 << numBits):
|
||||
if numBits < maxbits:
|
||||
numBufBits = bitPos = 0
|
||||
numBits += 1
|
||||
else:
|
||||
needPrev = 0
|
||||
|
||||
return out_data.tostring()
|
||||
|
||||
|
||||
# extract 16 bit unsigned int from data
|
||||
def get_uint16(data, off):
|
||||
return data[off] << 8 | data[off+1]
|
||||
|
||||
|
||||
# extract 32 bit unsigned int from data
|
||||
def get_uint32(data, off):
|
||||
return data[off] << 24 | data[off+1] << 16 | data[off+2] << 8 | data[off+3]
|
||||
|
||||
|
||||
# export IOU NVRAM
|
||||
def nvram_export(nvram):
|
||||
nvram = array('B', nvram)
|
||||
|
||||
# extract startup config
|
||||
offset = 0
|
||||
if len(nvram) < offset + 36:
|
||||
raise ValueError('invalid length')
|
||||
if get_uint16(nvram, offset + 0) != 0xABCD:
|
||||
raise ValueError('no startup config')
|
||||
format = get_uint16(nvram, offset + 2)
|
||||
length = get_uint32(nvram, offset + 16)
|
||||
offset += 36
|
||||
if len(nvram) < offset + length:
|
||||
raise ValueError('invalid length')
|
||||
startup = nvram[offset:offset+length].tostring()
|
||||
|
||||
# compressed startup config
|
||||
if format == 2:
|
||||
try:
|
||||
startup = uncompress_LZC(startup)
|
||||
except ValueError as err:
|
||||
raise ValueError('uncompress startup: ' + str(err))
|
||||
|
||||
offset += length
|
||||
# alignment to multiple of 4
|
||||
offset = (offset+3) & ~3
|
||||
# check for additonal offset of 4
|
||||
if len(nvram) >= offset + 8 and \
|
||||
get_uint16(nvram, offset + 4) == 0xFEDC and \
|
||||
get_uint16(nvram, offset + 6) == 1:
|
||||
offset += 4
|
||||
|
||||
# extract private config
|
||||
private = None
|
||||
if len(nvram) >= offset + 16 and get_uint16(nvram, offset + 0) == 0xFEDC:
|
||||
length = get_uint32(nvram, offset + 12)
|
||||
offset += 16
|
||||
if len(nvram) >= offset + length:
|
||||
private = nvram[offset:offset+length].tostring()
|
||||
|
||||
return (startup, private)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
# Main program
|
||||
|
||||
parser = argparse.ArgumentParser(description='%(prog)s exports startup/private configuration from IOU NVRAM file.')
|
||||
parser.add_argument('nvram', metavar='NVRAM',
|
||||
help='NVRAM file')
|
||||
parser.add_argument('startup', metavar='startup-config',
|
||||
help='startup configuration')
|
||||
parser.add_argument('private', metavar='private-config', nargs='?',
|
||||
help='private configuration')
|
||||
args = parser.parse_args()
|
||||
|
||||
try:
|
||||
fd = open(args.nvram, 'rb')
|
||||
nvram = fd.read()
|
||||
fd.close()
|
||||
except (IOError, OSError) as err:
|
||||
sys.stderr.write("Error reading file: {}\n".format(err))
|
||||
sys.exit(1)
|
||||
|
||||
try:
|
||||
startup, private = nvram_export(nvram)
|
||||
except ValueError as err:
|
||||
sys.stderr.write("nvram_export: {}\n".format(err))
|
||||
sys.exit(3)
|
||||
|
||||
try:
|
||||
fd = open(args.startup, 'wb')
|
||||
fd.write(startup)
|
||||
fd.close()
|
||||
if args.private is not None:
|
||||
if private is None:
|
||||
sys.stderr.write("Warning: No private config\n")
|
||||
else:
|
||||
fd = open(args.private, 'wb')
|
||||
fd.write(private)
|
||||
fd.close()
|
||||
except (IOError, OSError) as err:
|
||||
sys.stderr.write("Error writing file: {}\n".format(err))
|
||||
sys.exit(1)
|
||||
@@ -0,0 +1,241 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# To use python v2.7 change the first line to:
|
||||
#!/usr/bin/env python
|
||||
|
||||
# Copyright (C) 2015 Bernhard Ehlers
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
"""
|
||||
iou_import imports startup/private configuration into IOU NVRAM file.
|
||||
|
||||
usage: iou_import [-h] [-c size] NVRAM startup-config [private-config]
|
||||
|
||||
positional arguments:
|
||||
NVRAM NVRAM file
|
||||
startup-config startup configuration
|
||||
private-config private configuration
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-c size, --create size
|
||||
create NVRAM file, size in kByte
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import sys
|
||||
from array import array
|
||||
|
||||
|
||||
# extract 16 bit unsigned int from data
|
||||
def get_uint16(data, off):
|
||||
return data[off] << 8 | data[off+1]
|
||||
|
||||
|
||||
# extract 32 bit unsigned int from data
|
||||
def get_uint32(data, off):
|
||||
return data[off] << 24 | data[off+1] << 16 | data[off+2] << 8 | data[off+3]
|
||||
|
||||
|
||||
# insert 16 bit unsigned int into data
|
||||
def put_uint16(data, off, value):
|
||||
data[off] = (value >> 8) & 0xff
|
||||
data[off+1] = value & 0xff
|
||||
|
||||
|
||||
# insert 32 bit unsigned int into data
|
||||
def put_uint32(data, off, value):
|
||||
data[off] = (value >> 24) & 0xff
|
||||
data[off+1] = (value >> 16) & 0xff
|
||||
data[off+2] = (value >> 8) & 0xff
|
||||
data[off+3] = value & 0xff
|
||||
|
||||
|
||||
# calculate padding
|
||||
def padding(off, ios):
|
||||
pad = (4 - off % 4) % 4 # padding to alignment of 4
|
||||
if ios <= 0x0F00 and pad != 0: # add 4 if IOS <= 15.0
|
||||
pad += 4
|
||||
return pad
|
||||
|
||||
|
||||
# update checksum
|
||||
def checksum(data, start, end):
|
||||
put_uint16(data, start + 4, 0) # set checksum to 0
|
||||
|
||||
chk = 0
|
||||
idx = start
|
||||
while idx < end-1:
|
||||
chk += get_uint16(data, idx)
|
||||
idx += 2
|
||||
if idx < end:
|
||||
chk += data[idx] << 8
|
||||
|
||||
while chk >> 16:
|
||||
chk = (chk & 0xffff) + (chk >> 16)
|
||||
|
||||
chk = chk ^ 0xffff
|
||||
put_uint16(data, start + 4, chk) # set checksum
|
||||
|
||||
|
||||
# import IOU NVRAM
|
||||
def nvram_import(nvram, startup, private, size):
|
||||
BASE_ADDRESS = 0x10000000
|
||||
DEFAULT_IOS = 0x0F04 # IOS 15.4
|
||||
|
||||
if size is None:
|
||||
nvram = array('B', nvram)
|
||||
else:
|
||||
nvram = array('B', [0] * (size*1024))
|
||||
|
||||
# check nvram size
|
||||
nvram_len = len(nvram)
|
||||
if nvram_len < 8*1024 or nvram_len > 1024*1024 or nvram_len % 1024 != 0:
|
||||
raise ValueError('invalid length')
|
||||
nvram_len = nvram_len // 2
|
||||
|
||||
# get size of current config
|
||||
config_len = 0
|
||||
ios = None
|
||||
try:
|
||||
if get_uint16(nvram, 0) == 0xABCD:
|
||||
ios = get_uint16(nvram, 6)
|
||||
config_len = 36 + get_uint32(nvram, 16)
|
||||
config_len += padding(config_len, ios)
|
||||
if get_uint16(nvram, config_len) == 0xFEDC:
|
||||
config_len += 16 + get_uint32(nvram, config_len + 12)
|
||||
except IndexError:
|
||||
raise ValueError('unknown nvram format')
|
||||
if config_len > nvram_len:
|
||||
raise ValueError('unknown nvram format')
|
||||
|
||||
# calculate max. config size
|
||||
max_config = nvram_len - 2*1024 # reserve 2k for files
|
||||
idx = max_config
|
||||
empty_sector = array('B', [0] * 1024)
|
||||
while True:
|
||||
idx -= 1024
|
||||
if idx < config_len:
|
||||
break
|
||||
# if valid file header:
|
||||
if get_uint16(nvram, idx+0) == 0xDCBA and \
|
||||
get_uint16(nvram, idx+4) < 8 and \
|
||||
get_uint16(nvram, idx+6) <= 992:
|
||||
max_config = idx
|
||||
elif nvram[idx:idx+1024] != empty_sector:
|
||||
break
|
||||
|
||||
# import startup config
|
||||
startup = array('B', startup)
|
||||
if ios is None:
|
||||
# Target IOS version is unknown. As some IOU don't work nicely with
|
||||
# the padding of a different version, the startup config is padded
|
||||
# with '\n' to the alignment of 4.
|
||||
ios = DEFAULT_IOS
|
||||
startup.extend([ord('\n')] * ((4 - len(startup) % 4) % 4))
|
||||
new_nvram = array('B', [0] * 36) # startup hdr
|
||||
put_uint16(new_nvram, 0, 0xABCD) # magic
|
||||
put_uint16(new_nvram, 2, 1) # raw data
|
||||
put_uint16(new_nvram, 6, ios) # IOS version
|
||||
put_uint32(new_nvram, 8, BASE_ADDRESS+36) # start address
|
||||
put_uint32(new_nvram, 12, BASE_ADDRESS+36 + len(startup)) # end address
|
||||
put_uint32(new_nvram, 16, len(startup)) # length
|
||||
new_nvram.extend(startup)
|
||||
new_nvram.extend([0] * padding(len(new_nvram), ios))
|
||||
|
||||
# import private config
|
||||
if private is None:
|
||||
private = array('B')
|
||||
else:
|
||||
private = array('B', private)
|
||||
offset = len(new_nvram)
|
||||
new_nvram.extend([0] * 16) # private hdr
|
||||
put_uint16(new_nvram, 0 + offset, 0xFEDC) # magic
|
||||
put_uint16(new_nvram, 2 + offset, 1) # raw data
|
||||
put_uint32(new_nvram, 4 + offset,
|
||||
BASE_ADDRESS + offset + 16) # start address
|
||||
put_uint32(new_nvram, 8 + offset,
|
||||
BASE_ADDRESS + offset + 16 + len(private)) # end address
|
||||
put_uint32(new_nvram, 12 + offset, len(private)) # length
|
||||
new_nvram.extend(private)
|
||||
|
||||
# add rest
|
||||
if len(new_nvram) > max_config:
|
||||
raise ValueError('NVRAM size too small')
|
||||
new_nvram.extend([0] * (max_config - len(new_nvram)))
|
||||
new_nvram.extend(nvram[max_config:])
|
||||
|
||||
checksum(new_nvram, 0, nvram_len)
|
||||
|
||||
return new_nvram.tostring()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
# Main program
|
||||
|
||||
def check_size(string):
|
||||
try:
|
||||
value = int(string)
|
||||
except ValueError:
|
||||
raise argparse.ArgumentTypeError('invalid int value: ' + string)
|
||||
if value < 8 or value > 1024:
|
||||
raise argparse.ArgumentTypeError('size must be 8..1024')
|
||||
return value
|
||||
|
||||
parser = argparse.ArgumentParser(description='%(prog)s imports startup/private configuration into IOU NVRAM file.')
|
||||
parser.add_argument('-c', '--create', metavar='size', type=check_size,
|
||||
help='create NVRAM file, size in kByte')
|
||||
parser.add_argument('nvram', metavar='NVRAM',
|
||||
help='NVRAM file')
|
||||
parser.add_argument('startup', metavar='startup-config',
|
||||
help='startup configuration')
|
||||
parser.add_argument('private', metavar='private-config', nargs='?',
|
||||
help='private configuration')
|
||||
args = parser.parse_args()
|
||||
|
||||
try:
|
||||
if args.create is None:
|
||||
fd = open(args.nvram, 'rb')
|
||||
nvram = fd.read()
|
||||
fd.close()
|
||||
else:
|
||||
nvram = None
|
||||
fd = open(args.startup, 'rb')
|
||||
startup = fd.read()
|
||||
fd.close()
|
||||
if args.private is None:
|
||||
private = None
|
||||
else:
|
||||
fd = open(args.private, 'rb')
|
||||
private = fd.read()
|
||||
fd.close()
|
||||
except (IOError, OSError) as err:
|
||||
sys.stderr.write("Error reading file: {}\n".format(err))
|
||||
sys.exit(1)
|
||||
|
||||
try:
|
||||
nvram = nvram_import(nvram, startup, private, args.create)
|
||||
except ValueError as err:
|
||||
sys.stderr.write("nvram_import: {}\n".format(err))
|
||||
sys.exit(3)
|
||||
|
||||
try:
|
||||
fd = open(args.nvram, 'wb')
|
||||
fd.write(nvram)
|
||||
fd.close()
|
||||
except (IOError, OSError) as err:
|
||||
sys.stderr.write("Error writing file: {}\n".format(err))
|
||||
sys.exit(1)
|
||||
Reference in new issue
Block a user