diff -Nru librouteros-2.1.1/.bumpversion.cfg librouteros-2.2.0/.bumpversion.cfg --- librouteros-2.1.1/.bumpversion.cfg 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/.bumpversion.cfg 2018-11-11 18:37:23.000000000 +0000 @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.1.1 +current_version = 2.2.0 commit = True tag = True tag_name = {new_version} diff -Nru librouteros-2.1.1/CHANGELOG.rst librouteros-2.2.0/CHANGELOG.rst --- librouteros-2.1.1/CHANGELOG.rst 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/CHANGELOG.rst 2018-11-11 18:37:23.000000000 +0000 @@ -1,3 +1,8 @@ +2.2.0 +---------- + +- Excplicit login_method parameter for login using new or old auth method. + 2.1.1 ---------- diff -Nru librouteros-2.1.1/debian/changelog librouteros-2.2.0/debian/changelog --- librouteros-2.1.1/debian/changelog 2018-09-11 23:01:45.000000000 +0000 +++ librouteros-2.2.0/debian/changelog 2018-12-02 13:30:30.000000000 +0000 @@ -1,3 +1,9 @@ +librouteros (2.2.0-1) unstable; urgency=medium + + * New upstream version 2.2.0 + + -- Alexander GQ Gerasiov Sun, 02 Dec 2018 16:30:30 +0300 + librouteros (2.1.1-1) unstable; urgency=medium * New upstream version 2.1.1 diff -Nru librouteros-2.1.1/docs/api_analysis.rst librouteros-2.2.0/docs/api_analysis.rst --- librouteros-2.1.1/docs/api_analysis.rst 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/api_analysis.rst 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,312 @@ +Api analysis +============ + +This document aims to cover in depth analysis of routeros API. Lines that begin with ``--->`` represent data received from a device. Linet that start with ``<---`` represent data send to a device. End of sentence is marked with ``EOS``. + +Succesfull login (pre 6.43) +--------------------------- +.. code-block:: none + + <--- /login + <--- EOS + + ---> !done + ---> =ret=xxxxxxxxxxxxxxxxxxxxx + ---> EOS + + <--- /login + <--- =name=admin + <--- =response=xxxxxxxxxxxxxxx + <--- EOS + + ---> !done + ---> EOS + +Succesfull login (post 6.43) +---------------------------- +.. code-block:: none + + <--- /login + <--- =name=admin + <--- =password=xxxxxxxxxxxxxxx + <--- EOS + + ---> !done + ---> EOS + +Failed login attempt (pre 6.43) +------------------------------- +.. code-block:: none + + <--- /login + <--- EOS + + ---> !done + ---> =ret=xxxxxxxxxxxxxxxxxxxxx + ---> EOS + + <--- /login + <--- =name=admin + <--- =response=xxxxxxxxxxxxxxxxxxxxx + <--- EOS + + ---> !trap + ---> =message=cannot log in + ---> EOS + ---> !done + ---> EOS + +Logging off +----------- +.. code-block:: none + + <--- /quit + <--- EOS + + ---> !fatal + ---> session terminated on request + ---> EOS + +Multiple empty responses +------------------------ +.. code-block:: none + + <--- /ip/service/print + <--- =.proplist=comment + <--- EOS + + ---> !re + ---> EOS + ---> !re + ---> EOS + ---> !re + ---> EOS + ---> !re + ---> EOS + ---> !re + ---> EOS + ---> !re + ---> EOS + ---> !re + ---> EOS + ---> !done + ---> EOS + +Adding element +-------------- +.. code-block:: none + + <--- /ip/address/add + <--- =address=192.168.1.1/24 + <--- =interface=ether1 + <--- EOS + + ---> !done + ---> =ret=*3 + ---> EOS + +Canceling ``listen`` +-------------------- +Command returns ``!trap`` which is not actually any error at all: + +.. code-block:: none + + <--- '/ip/address/listen' + <--- '.tag=10' + <--- EOS + + ---> '!re' + ---> '.tag=10' + ---> '=.id=*A' + ---> '=address=1.1.1.1/32' + ---> '=network=1.1.1.1' + ---> '=interface=br-lan' + ---> '=actual-interface=br-lan' + ---> '=invalid=false' + ---> '=dynamic=false' + ---> '=disabled=false' + ---> EOS + ---> '!re' + ---> '.tag=10' + ---> '=.id=*A' + ---> '=.dead=true' + ---> EOS + + <--- '/cancel' + <--- '=tag=10' + <--- '.tag=20' + <--- EOS + + ---> '!trap' + ---> '.tag=10' + ---> '=category=2' + ---> '=message=interrupted' + ---> EOS + ---> '!done' + ---> '.tag=20' + ---> EOS + ---> '!done' + ---> '.tag=10' + ---> EOS + + +Fetching from url +----------------- + +.. code-block:: none + + <--- '/tool/fetch' + <--- '=url=http://ping.online.net/10Mo.dat' + <--- '.tag=1' + <--- EOS + + ---> '!re' + ---> '.tag=1' + ---> '=status=connecting' + ---> '=.section=0' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=731' + ---> '=total=9765' + ---> '=duration=1s' + ---> '=.section=1' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=1579' + ---> '=total=9765' + ---> '=duration=2s' + ---> '=.section=2' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=2427' + ---> '=total=9765' + ---> '=duration=3s' + ---> '=.section=3' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=3275' + ---> '=total=9765' + ---> '=duration=4s' + ---> '=.section=4' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=4139' + ---> '=total=9765' + ---> '=duration=5s' + ---> '=.section=5' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=4987' + ---> '=total=9765' + ---> '=duration=6s' + ---> '=.section=6' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=5839' + ---> '=total=9765' + ---> '=duration=7s' + ---> '=.section=7' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=6687' + ---> '=total=9765' + ---> '=duration=8s' + ---> '=.section=8' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=7551' + ---> '=total=9765' + ---> '=duration=9s' + ---> '=.section=9' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=8415' + ---> '=total=9765' + ---> '=duration=10s' + ---> '=.section=10' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=9279' + ---> '=total=9765' + ---> '=duration=12s' + ---> '=.section=11' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=finished' + ---> '=downloaded=9765' + ---> '=total=9765' + ---> '=duration=13s' + ---> '=.section=12' + ---> EOS + ---> '!done' + ---> '.tag=1' + ---> EOS + +Canceling fetch +--------------- + +.. code-block:: none + + <--- '/tool/fetch' + <--- '=url=http://ping.online.net/10Mo.dat' + <--- '.tag=1' + <--- EOS + + ---> '!re' + ---> '.tag=1' + ---> '=status=connecting' + ---> '=.section=0' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=18' + ---> '=total=9765' + ---> '=duration=0s' + ---> '=.section=1' + ---> EOS + ---> '!re' + ---> '.tag=1' + ---> '=status=downloading' + ---> '=downloaded=853' + ---> '=total=9765' + ---> '=duration=1s' + ---> '=.section=2' + ---> EOS + + <--- '/cancel' + <--- '=tag=1' + <--- EOS + ---> '!trap' + ---> '.tag=1' + ---> '=category=2' + ---> '=message=interrupted' + ---> EOS + ---> '!done' + ---> EOS + ---> '!done' + ---> '.tag=1' + ---> EOS diff -Nru librouteros-2.1.1/docs/conf.py librouteros-2.2.0/docs/conf.py --- librouteros-2.1.1/docs/conf.py 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/conf.py 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,64 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = '1.5' + +# Add any Sphinx extension module names here, as strings. +# They can be extensions coming with Sphinx (named 'sphinx.ext.*') +# or your custom ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'librouteros' +copyright = u'Łukasz Kostka' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +language = 'en' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# The theme to use for HTML and HTML Help pages. +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +html_show_copyright = True + +# Output file base name for HTML help builder. +htmlhelp_basename = 'librouteros' diff -Nru librouteros-2.1.1/docs/contributing.rst librouteros-2.2.0/docs/contributing.rst --- librouteros-2.1.1/docs/contributing.rst 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/contributing.rst 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,3 @@ +Contributing +============ +To submit a feature requests or a bug report, please use issues from within github. If you would like to submit a patch please contact author or use pull request. diff -Nru librouteros-2.1.1/docs/.gitignore librouteros-2.2.0/docs/.gitignore --- librouteros-2.1.1/docs/.gitignore 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/.gitignore 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1 @@ +_build diff -Nru librouteros-2.1.1/docs/index.rst librouteros-2.2.0/docs/index.rst --- librouteros-2.1.1/docs/index.rst 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/index.rst 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,35 @@ +Librouteros - Routeros api implementation +========================================= + +.. image:: https://travis-ci.org/luqasz/librouteros.svg?branch=master + :target: https://travis-ci.org/luqasz/librouteros + :alt: Tests + +.. image:: https://img.shields.io/pypi/v/librouteros.svg + :target: https://pypi.python.org/pypi/librouteros/ + :alt: Latest PyPI version + +.. image:: https://img.shields.io/pypi/pyversions/librouteros.svg + :target: https://pypi.python.org/pypi/librouteros/ + :alt: Supported Python Versions + +.. image:: https://img.shields.io/pypi/l/librouteros.svg + :target: https://pypi.python.org/pypi/librouteros/ + :alt: License + +.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg + :target: https://saythanks.io/to/luqasz + :alt: Say Thanks + +About +_____ +Python implementation of `routeros api `_. This library uses `semantic versioning `_. On major version things may break, so pin version in dependencies. + +.. toctree:: + :maxdepth: 2 + + introduction + usage + api_analysis + license + contributing diff -Nru librouteros-2.1.1/docs/introduction.rst librouteros-2.2.0/docs/introduction.rst --- librouteros-2.1.1/docs/introduction.rst 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/introduction.rst 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,24 @@ +Introduction +============ + + +Features +-------- + +* Python type casting +* Key and values stored in dictionary +* Source address, port specification +* TLS/SSL socket encryption +* Logging support + +Limitations +----------- + +* No support for sentence tagging. +* No asynchronous support for reading/writing + +Requirements +------------ + +* Python 2 or 3, with sufficiently recent versions of `pip` and `setuptools` +* Mock (for runing unit tests). diff -Nru librouteros-2.1.1/docs/license.rst librouteros-2.2.0/docs/license.rst --- librouteros-2.1.1/docs/license.rst 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/license.rst 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,5 @@ +License +------- + +.. include:: ../LICENSE + :literal: diff -Nru librouteros-2.1.1/docs/Makefile librouteros-2.2.0/docs/Makefile --- librouteros-2.1.1/docs/Makefile 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/Makefile 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/librouteros.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/librouteros.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/librouteros" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/librouteros" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff -Nru librouteros-2.1.1/docs/usage.rst librouteros-2.2.0/docs/usage.rst --- librouteros-2.1.1/docs/usage.rst 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/docs/usage.rst 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,126 @@ +Library usage +============= + +.. note:: + + This library comes with built in documentation. Run ``help(method)`` to get the docs. + +Type casting +------------ + +Python booleans are converted according to this table: + +====== ========= ======== +python direction api +====== ========= ======== +False <- false,no +True <- true,yes +False -> no +True -> yes +====== ========= ======== + +Integers are converted to python int objects. + +Connecting +---------- + +.. code-block:: python + + from librouteros import connect + + api = connect(username='admin', password='abc', host='some.address.com') + +Before connecting, ``api-ssl`` service on routeros must have a valid certificate set. +For more information on how to generate such certificates see `MikroTik wiki `_. +After that, create your default `SSLContext `_ and fine tune for your needs. + +.. code-block:: python + + import ssl + from librouteros import connect + + ctx = ssl.create_default_context() + ctx.check_hostname = False + ctx.verify_mode = ssl.CERT_NONE + api = connect( + username='admin', + password='abc', + host='some.address.com', + ssl_wrapper=ctx.wrap_socket, + port=8729 + ) + + +New auth method +--------------- + +Starting from routeros ``6.43``, new auth method was introduced. By default library will try to login using old method first (with token), then new (using plain text password) method. You can force library to try only one method: + +.. code-block:: python + + from librouteros.login import login_plain, login_token + + # for new (plain text password) + method = (login_plain, ) + # for old (with token) + method = (login_token, ) + api = connect(username='admin', password='abc', host='some.address.com', login_methods=method) + + +Printing elements +----------------- + +.. code-block:: python + + api(cmd='/interface/print', stats=True) + ({'.id': '*1', + 'bytes': '418152/157562', + 'comment': '', + 'disabled': False, + 'drops': '0/0', + 'dynamic': False, + 'errors': '0/0', + 'mtu': 1500, + 'name': 'ether1', + 'packets': '3081/1479', + 'running': True, + 'type': 'ether'},) + + api(cmd='/interface/print') + ({'.id': '*1', + 'comment': '', + 'disabled': False, + 'dynamic': False, + 'mtu': 1500, + 'name': 'ether1', + 'running': True, + 'type': 'ether'},) + +If you want to pass parameters that start with a dot character you can do it in this way: + +.. code-block:: python + + params = {'disabled': True, '.id' :'*7'} + api(cmd='/ip/firewall/nat/set', **params) + +Note that ``.id`` must always be passed as read from API. They usually start with a ``*`` followed by a number. +Keep in mind that they do change across reboots. As a rule of thumb, always read them first. + +Adding element +-------------- + +.. code-block:: python + + data = {'interface':'ether1', 'address':'172.31.31.1/24'} + ID = api.run('/ip/address/add', data) + # get newly created ID + ID[0]['ret'] + '*23' + +Removing element +---------------- + +.. code-block:: python + + params = {'.id' :'*7'} + api.run('/ip/address/remove', **params) diff -Nru librouteros-2.1.1/librouteros/__init__.py librouteros-2.2.0/librouteros/__init__.py --- librouteros-2.1.1/librouteros/__init__.py 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/librouteros/__init__.py 2018-11-11 18:37:23.000000000 +0000 @@ -1,8 +1,6 @@ # -*- coding: UTF-8 -*- from socket import create_connection, error as SOCKET_ERROR, timeout as SOCKET_TIMEOUT -from binascii import unhexlify, hexlify -from hashlib import md5 try: from collections import ChainMap except ImportError: @@ -10,6 +8,7 @@ from librouteros.exceptions import TrapError, FatalError, ConnectionError, MultiTrapError from librouteros.connections import ApiProtocol, SocketTransport +from librouteros.login import login_plain, login_token from librouteros.api import Api @@ -20,6 +19,7 @@ 'subclass': Api, 'encoding': 'ASCII', 'ssl_wrapper': lambda sock: sock, + 'login_methods': (login_token, login_plain), } @@ -36,28 +36,22 @@ :param saddr: Source address to bind to. :param subclass: Subclass of Api class. Defaults to Api class from library. :param ssl_wrapper: Callable (e.g. ssl.SSLContext instance) to wrap socket with. + :param login_methods: Tuple with callables to login methods to try in order. """ arguments = ChainMap(kwargs, defaults) transport = create_transport(host, **arguments) protocol = ApiProtocol(transport=transport, encoding=arguments['encoding']) api = arguments['subclass'](protocol=protocol) - try: - # First send dummy credentials to know if we get a =ret= back. - # This way we know if it is a pre 6.43 auth method or not. - sentence = api('/login', **{'name': 'dummy_user', 'password': 'dummy_password'}) - token = sentence[0]['ret'] - except (TrapError, MultiTrapError): - # Login failed so use 6.43 auth method. - api('/login', **{'name': username, 'password': password}) - except (ConnectionError, FatalError): - transport.close() - raise - else: - # We got =ret= so use pre 6.43 auth method. - api('/login', **{'name': username, 'response': encode_password(token, password)}) - - return api + for method in arguments['login_methods']: + try: + method(api=api, username=username, password=password) + return api + except (TrapError, MultiTrapError): + pass + except (ConnectionError, FatalError): + transport.close() + raise def create_transport(host, **kwargs): @@ -68,14 +62,3 @@ except (SOCKET_ERROR, SOCKET_TIMEOUT) as error: raise ConnectionError(error) return SocketTransport(sock=sock) - - -def encode_password(token, password): - - token = token.encode('ascii', 'strict') - token = unhexlify(token) - password = password.encode('ascii', 'strict') - md = md5() - md.update(b'\x00' + password + token) - password = hexlify(md.digest()) - return '00' + password.decode('ascii', 'strict') diff -Nru librouteros-2.1.1/librouteros/login.py librouteros-2.2.0/librouteros/login.py --- librouteros-2.1.1/librouteros/login.py 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/librouteros/login.py 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,25 @@ +from binascii import unhexlify, hexlify +from hashlib import md5 + + +def encode_password(token, password): + token = token.encode('ascii', 'strict') + token = unhexlify(token) + password = password.encode('ascii', 'strict') + md = md5() + md.update(b'\x00' + password + token) + password = hexlify(md.digest()) + return '00' + password.decode('ascii', 'strict') + + +def login_token(api, username, password): + """Login using pre routeros 6.43 authorization method.""" + sentence = api('/login') + token = sentence[0]['ret'] + encoded = encode_password(token, password) + api('/login', **{'name': username, 'response': encoded}) + + +def login_plain(api, username, password): + """Login using post routeros 6.43 authorization method.""" + api('/login', **{'name': username, 'password': password}) diff -Nru librouteros-2.1.1/LICENSE librouteros-2.2.0/LICENSE --- librouteros-2.1.1/LICENSE 1970-01-01 00:00:00.000000000 +0000 +++ librouteros-2.2.0/LICENSE 2018-11-11 18:37:23.000000000 +0000 @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff -Nru librouteros-2.1.1/LICENSE.md librouteros-2.2.0/LICENSE.md --- librouteros-2.1.1/LICENSE.md 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/LICENSE.md 1970-01-01 00:00:00.000000000 +0000 @@ -1,264 +0,0 @@ -The GNU General Public License, Version 2, June 1991 (GPLv2) -============================================================ - -> Copyright (C) 1989, 1991 Free Software Foundation, Inc. -> 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - -Everyone is permitted to copy and distribute verbatim copies of this license -document, but changing it is not allowed. - - -Preamble --------- - -The licenses for most software are designed to take away your freedom to share -and change it. By contrast, the GNU General Public License is intended to -guarantee your freedom to share and change free software--to make sure the -software is free for all its users. This General Public License applies to most -of the Free Software Foundation's software and to any other program whose -authors commit to using it. (Some other Free Software Foundation software is -covered by the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - -When we speak of free software, we are referring to freedom, not price. Our -General Public Licenses are designed to make sure that you have the freedom to -distribute copies of free software (and charge for this service if you wish), -that you receive source code or can get it if you want it, that you can change -the software or use pieces of it in new free programs; and that you know you can -do these things. - -To protect your rights, we need to make restrictions that forbid anyone to deny -you these rights or to ask you to surrender the rights. These restrictions -translate to certain responsibilities for you if you distribute copies of the -software, or if you modify it. - -For example, if you distribute copies of such a program, whether gratis or for a -fee, you must give the recipients all the rights that you have. You must make -sure that they, too, receive or can get the source code. And you must show them -these terms so they know their rights. - -We protect your rights with two steps: (1) copyright the software, and (2) offer -you this license which gives you legal permission to copy, distribute and/or -modify the software. - -Also, for each author's protection and ours, we want to make certain that -everyone understands that there is no warranty for this free software. If the -software is modified by someone else and passed on, we want its recipients to -know that what they have is not the original, so that any problems introduced by -others will not reflect on the original authors' reputations. - -Finally, any free program is threatened constantly by software patents. We wish -to avoid the danger that redistributors of a free program will individually -obtain patent licenses, in effect making the program proprietary. To prevent -this, we have made it clear that any patent must be licensed for everyone's free -use or not licensed at all. - -The precise terms and conditions for copying, distribution and modification -follow. - - -Terms And Conditions For Copying, Distribution And Modification ---------------------------------------------------------------- - -**0.** This License applies to any program or other work which contains a notice -placed by the copyright holder saying it may be distributed under the terms of -this General Public License. The "Program", below, refers to any such program or -work, and a "work based on the Program" means either the Program or any -derivative work under copyright law: that is to say, a work containing the -Program or a portion of it, either verbatim or with modifications and/or -translated into another language. (Hereinafter, translation is included without -limitation in the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not covered by -this License; they are outside its scope. The act of running the Program is not -restricted, and the output from the Program is covered only if its contents -constitute a work based on the Program (independent of having been made by -running the Program). Whether that is true depends on what the Program does. - -**1.** You may copy and distribute verbatim copies of the Program's source code -as you receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice and -disclaimer of warranty; keep intact all the notices that refer to this License -and to the absence of any warranty; and give any other recipients of the Program -a copy of this License along with the Program. - -You may charge a fee for the physical act of transferring a copy, and you may at -your option offer warranty protection in exchange for a fee. - -**2.** You may modify your copy or copies of the Program or any portion of it, -thus forming a work based on the Program, and copy and distribute such -modifications or work under the terms of Section 1 above, provided that you also -meet all of these conditions: - -* **a)** You must cause the modified files to carry prominent notices stating - that you changed the files and the date of any change. - -* **b)** You must cause any work that you distribute or publish, that in whole - or in part contains or is derived from the Program or any part thereof, to - be licensed as a whole at no charge to all third parties under the terms of - this License. - -* **c)** If the modified program normally reads commands interactively when - run, you must cause it, when started running for such interactive use in the - most ordinary way, to print or display an announcement including an - appropriate copyright notice and a notice that there is no warranty (or - else, saying that you provide a warranty) and that users may redistribute - the program under these conditions, and telling the user how to view a copy - of this License. (Exception: if the Program itself is interactive but does - not normally print such an announcement, your work based on the Program is - not required to print an announcement.) - -These requirements apply to the modified work as a whole. If identifiable -sections of that work are not derived from the Program, and can be reasonably -considered independent and separate works in themselves, then this License, and -its terms, do not apply to those sections when you distribute them as separate -works. But when you distribute the same sections as part of a whole which is a -work based on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the entire whole, -and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest your -rights to work written entirely by you; rather, the intent is to exercise the -right to control the distribution of derivative or collective works based on the -Program. - -In addition, mere aggregation of another work not based on the Program with the -Program (or with a work based on the Program) on a volume of a storage or -distribution medium does not bring the other work under the scope of this -License. - -**3.** You may copy and distribute the Program (or a work based on it, under -Section 2) in object code or executable form under the terms of Sections 1 and 2 -above provided that you also do one of the following: - -* **a)** Accompany it with the complete corresponding machine-readable source - code, which must be distributed under the terms of Sections 1 and 2 above on - a medium customarily used for software interchange; or, - -* **b)** Accompany it with a written offer, valid for at least three years, to - give any third party, for a charge no more than your cost of physically - performing source distribution, a complete machine-readable copy of the - corresponding source code, to be distributed under the terms of Sections 1 - and 2 above on a medium customarily used for software interchange; or, - -* **c)** Accompany it with the information you received as to the offer to - distribute corresponding source code. (This alternative is allowed only for - noncommercial distribution and only if you received the program in object - code or executable form with such an offer, in accord with Subsection b - above.) - -The source code for a work means the preferred form of the work for making -modifications to it. For an executable work, complete source code means all the -source code for all modules it contains, plus any associated interface -definition files, plus the scripts used to control compilation and installation -of the executable. However, as a special exception, the source code distributed -need not include anything that is normally distributed (in either source or -binary form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component itself -accompanies the executable. - -If distribution of executable or object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the source code -from the same place counts as distribution of the source code, even though third -parties are not compelled to copy the source along with the object code. - -**4.** You may not copy, modify, sublicense, or distribute the Program except as -expressly provided under this License. Any attempt otherwise to copy, modify, -sublicense or distribute the Program is void, and will automatically terminate -your rights under this License. However, parties who have received copies, or -rights, from you under this License will not have their licenses terminated so -long as such parties remain in full compliance. - -**5.** You are not required to accept this License, since you have not signed -it. However, nothing else grants you permission to modify or distribute the -Program or its derivative works. These actions are prohibited by law if you do -not accept this License. Therefore, by modifying or distributing the Program (or -any work based on the Program), you indicate your acceptance of this License to -do so, and all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - -**6.** Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the original -licensor to copy, distribute or modify the Program subject to these terms and -conditions. You may not impose any further restrictions on the recipients' -exercise of the rights granted herein. You are not responsible for enforcing -compliance by third parties to this License. - -**7.** If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), conditions -are imposed on you (whether by court order, agreement or otherwise) that -contradict the conditions of this License, they do not excuse you from the -conditions of this License. If you cannot distribute so as to satisfy -simultaneously your obligations under this License and any other pertinent -obligations, then as a consequence you may not distribute the Program at all. -For example, if a patent license would not permit royalty-free redistribution of -the Program by all those who receive copies directly or indirectly through you, -then the only way you could satisfy both it and this License would be to refrain -entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply and the -section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any patents or -other property right claims or to contest validity of any such claims; this -section has the sole purpose of protecting the integrity of the free software -distribution system, which is implemented by public license practices. Many -people have made generous contributions to the wide range of software -distributed through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing to -distribute software through any other system and a licensee cannot impose that -choice. - -This section is intended to make thoroughly clear what is believed to be a -consequence of the rest of this License. - -**8.** If the distribution and/or use of the Program is restricted in certain -countries either by patents or by copyrighted interfaces, the original copyright -holder who places the Program under this License may add an explicit -geographical distribution limitation excluding those countries, so that -distribution is permitted only in or among countries not thus excluded. In such -case, this License incorporates the limitation as if written in the body of this -License. - -**9.** The Free Software Foundation may publish revised and/or new versions of -the General Public License from time to time. Such new versions will be similar -in spirit to the present version, but may differ in detail to address new -problems or concerns. - -Each version is given a distinguishing version number. If the Program specifies -a version number of this License which applies to it and "any later version", -you have the option of following the terms and conditions either of that version -or of any later version published by the Free Software Foundation. If the -Program does not specify a version number of this License, you may choose any -version ever published by the Free Software Foundation. - -**10.** If you wish to incorporate parts of the Program into other free programs -whose distribution conditions are different, write to the author to ask for -permission. For software which is copyrighted by the Free Software Foundation, -write to the Free Software Foundation; we sometimes make exceptions for this. -Our decision will be guided by the two goals of preserving the free status of -all derivatives of our free software and of promoting the sharing and reuse of -software generally. - - -No Warranty ------------ - -**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR -THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE -STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM -"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, -BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A -PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - -**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR -INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA -BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER -OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. diff -Nru librouteros-2.1.1/README.rst librouteros-2.2.0/README.rst --- librouteros-2.1.1/README.rst 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/README.rst 2018-11-11 18:37:23.000000000 +0000 @@ -1,104 +1,5 @@ -.. image:: https://travis-ci.org/luqasz/librouteros.svg?branch=master - :target: https://travis-ci.org/luqasz/librouteros - :alt: Tests +Documentation +============= -.. image:: https://img.shields.io/pypi/v/librouteros.svg - :target: https://pypi.python.org/pypi/librouteros/ - :alt: Latest PyPI version - -.. image:: https://img.shields.io/pypi/pyversions/librouteros.svg - :target: https://pypi.python.org/pypi/librouteros/ - :alt: Supported Python Versions - -.. image:: https://img.shields.io/pypi/l/librouteros.svg - :target: https://pypi.python.org/pypi/librouteros/ - :alt: License - -About -===== -Python implementation of `routeros api `_. This library uses `semantic versioning `_. On major version things may break, so pin version in dependencies. - - -Usage -===== - -.. code-block:: python - - from librouteros import connect - - api = connect(username='admin', password='abc', host='some.address.com') - -For SSL/TLS you need to create a ssl.SSLContext instance and pass it to ``connect()``. -Bare minimal requirement for ssl to work (without certificates). - -.. code-block:: python - - import ssl - from librouteros import connect - - ctx = ssl.create_default_context() - ctx.check_hostname = False - ctx.verify_mode = ssl.CERT_NONE - ctx.set_ciphers('ADH') - api = connect(username='admin', password='abc', host='some.address.com', ssl_wrapper=ctx.wrap_socket, port=8729) - - -Api usage. - -.. code-block:: python - - api(cmd='/interface/print', stats=True) - ({'.id': '*1', - 'bytes': '418152/157562', - 'comment': '', - 'disabled': False, - 'drops': '0/0', - 'dynamic': False, - 'errors': '0/0', - 'mtu': 1500, - 'name': 'ether1', - 'packets': '3081/1479', - 'running': True, - 'type': 'ether'},) - - api(cmd='/interface/print') - ({'.id': '*1', - 'comment': '', - 'disabled': False, - 'dynamic': False, - 'mtu': 1500, - 'name': 'ether1', - 'running': True, - 'type': 'ether'},) - - api.close() - -If you want to pass parameters that start with a dot character you can do it in this way: - -.. code-block:: python - - params = {'disabled': True, '.id' :'*7'} - api(cmd='/ip/firewall/nat/set', **params) - -Note that ``.id`` must always be passed as read from API. They usually start with a ``*`` followed by a number. -Keep in mind that they do change across reboots. As a rule of thumb, always read them first. - - -Booleans conversions -==================== - -Python booleans are converted according to this table: - -====== ========= ======== -python direction api -====== ========= ======== -False <- false,no -True <- true,yes -False -> no -True -> yes -====== ========= ======== - - -Contributing -============ -To submit a feature requests or a bug report, please use issues from within github. If you would like to submit a patch please contact author or use pull request. +Documentation resides over at +`readthedocs `_ diff -Nru librouteros-2.1.1/setup.cfg librouteros-2.2.0/setup.cfg --- librouteros-2.1.1/setup.cfg 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/setup.cfg 2018-11-11 18:37:23.000000000 +0000 @@ -1,10 +1,10 @@ -[pylama] +[pylava] linters = mccabe,pep8,pyflakes,pydocstyle # Ignore stupid often mutually exclusive errors. ignore = D102,D103,D100,D104,D101,D105,D203,D212,D107,D205,D400 -[pylama:pep8] +[pylava:pep8] max_line_length = 100 [tool:pytest] -addopts = --strict -ra --pylama +addopts = --strict -ra --pylava diff -Nru librouteros-2.1.1/setup.py librouteros-2.2.0/setup.py --- librouteros-2.1.1/setup.py 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/setup.py 2018-11-11 18:37:23.000000000 +0000 @@ -27,7 +27,7 @@ tests_pkgs = ( 'pytest-xdist==1.*', 'pytest==3.*', # pytest 3.x does not work on python 3.2 - 'pylama', + 'pylava', 'pydocstyle', 'mock', ) @@ -50,7 +50,7 @@ }, zip_safe=False, name='librouteros', - version='2.1.1', + version='2.2.0', description='Python implementation of MikroTik RouterOS API', long_description=read('README.rst'), author='Łukasz Kostka', diff -Nru librouteros-2.1.1/tests/unit/test_librouteros.py librouteros-2.2.0/tests/unit/test_librouteros.py --- librouteros-2.1.1/tests/unit/test_librouteros.py 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/tests/unit/test_librouteros.py 2018-11-11 18:37:23.000000000 +0000 @@ -2,7 +2,12 @@ import pytest -from librouteros import encode_password, defaults, Api +from librouteros import defaults, Api +from librouteros.login import ( + encode_password, + login_plain, + login_token, +) def test_lib_default_arguments(): @@ -13,6 +18,7 @@ 'subclass': Api, 'encoding': 'ASCII', 'ssl_wrapper': defaults['ssl_wrapper'], + 'login_methods': (login_token, login_plain), } == defaults diff -Nru librouteros-2.1.1/.travis.yml librouteros-2.2.0/.travis.yml --- librouteros-2.1.1/.travis.yml 2018-08-18 23:54:15.000000000 +0000 +++ librouteros-2.2.0/.travis.yml 2018-11-11 18:37:23.000000000 +0000 @@ -11,6 +11,7 @@ - 3.4 - 3.5 - 3.6 + # - 3.7 see https://github.com/travis-ci/travis-ci/issues/9815 addons: apt: packages: @@ -19,10 +20,9 @@ install: - pip install -e '.[tests]' script: - - pylama - wget --quiet netng.pl/routeros_test_images/routeros_6.33.3.qcow2 -O images/routeros_6.33.3.qcow2 - wget --quiet netng.pl/routeros_test_images/routeros_6.43rc21.qcow2 -O images/routeros_6.43rc21.qcow2 - - py.test --pylama + - py.test --pylava deploy: provider: pypi user: lkostka