Attachment 207445 Details for Bug 240476 – Patch to support fido/u2f on FreeBSD, now with unit test support

[patch] Patch to support fido/u2f on FreeBSD, now with unit test support

patch-py-fido2-freebsd-20190913.txt (text/plain), 14.63 KB, created by Michael Gmelin on 2019-09-12 23:39:51 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Michael Gmelin

Created: 2019-09-12 23:39:51 UTC

Size: 14.63 KB

patch

obsolete

>See: Add FreeBSD support https://github.com/Yubico/python-fido2/pull/64
>Index: security/py-fido2/Makefile
>===================================================================
>--- security/py-fido2/Makefile	(revision 511842)
>+++ security/py-fido2/Makefile	(working copy)
>@@ -2,6 +2,7 @@
> 
> PORTNAME=	fido2
> PORTVERSION=	0.7.0
>+PORTREVISION=	1
> CATEGORIES=	security python
> MASTER_SITES=	CHEESESHOP
> PKGNAMEPREFIX=	${PYTHON_PKGNAMEPREFIX}
>@@ -12,9 +13,15 @@
> LICENSE=	BSD2CLAUSE
> LICENSE_FILE=	${WRKSRC}/COPYING
> 
>+BUILD_DEPENDS=	${PYTHON_PKGNAMEPREFIX}pytest-runner>0:devel/py-pytest-runner@${PY_FLAVOR}
> RUN_DEPENDS=	${PYTHON_PKGNAMEPREFIX}cryptography>=1.5:security/py-cryptography@${PY_FLAVOR} \
> 		${PY_ENUM34} \
>-		${PYTHON_PKGNAMEPREFIX}six>=0:devel/py-six@${PY_FLAVOR}
>+		${PYTHON_PKGNAMEPREFIX}six>=0:devel/py-six@${PY_FLAVOR} \
>+		${PYTHON_PKGNAMEPREFIX}uhid-freebsd>=1.0:devel/py-uhid-freebsd@${PY_FLAVOR}
>+TEST_DEPENDS=	${PYTHON_PKGNAMEPREFIX}mock>0:devel/py-mock@${PY_FLAVOR} \
>+		${PYTHON_PKGNAMEPREFIX}pycodestyle>0:devel/py-pycodestyle@${PY_FLAVOR} \
>+		${PYTHON_PKGNAMEPREFIX}pytest>0:devel/py-pytest@${PY_FLAVOR} \
>+		${PYTHON_PKGNAMEPREFIX}uhid-freebsd>=1.0:devel/py-uhid-freebsd@${PY_FLAVOR}
> 
> USES=		python
> USE_PYTHON=	autoplist distutils
>@@ -21,4 +28,7 @@
> 
> NO_ARCH=	yes
> 
>+do-test:
>+	@cd ${WRKSRC} && ${PYTHON_CMD} ${PYDISTUTILS_SETUP} test
>+
> .include <bsd.port.mk>
>Index: security/py-fido2/files/patch-README.adoc
>===================================================================
>--- security/py-fido2/files/patch-README.adoc	(nonexistent)
>+++ security/py-fido2/files/patch-README.adoc	(working copy)
>@@ -0,0 +1,19 @@
>+--- README.adoc.orig	2019-06-17 12:31:00 UTC
>++++ README.adoc
>+@@ -64,10 +64,15 @@ KERNEL=="hidraw*", SUBSYSTEM=="hidraw", \
>+   MODE="0664", GROUP="plugdev", ATTRS{idVendor}=="1050"
>+ ----
>+ 
>++Under FreeBSD you will either need to run as root or add rules for your device
>++to /etc/devd.conf, which can be automated by installing security/u2f-devd:
>+ 
>++  # pkg install u2f-devd
>++
>++
>+ === Dependencies
>+ fido2 is compatible with CPython 2.7 (2.7.6 and up), 3.4 onwards, and is tested
>+-on Windows, MacOS, and Linux.
>++on Windows, MacOS, FreeBSD, and Linux.
>+ 
>+ This project depends on Cryptography. For instructions on installing this
>+ dependency, see https://cryptography.io/en/latest/installation/.
>
>Property changes on: security/py-fido2/files/patch-README.adoc
>___________________________________________________________________
>Added: fbsd:nokeywords
>## -0,0 +1 ##
>+yes
>\ No newline at end of property
>Added: svn:eol-style
>## -0,0 +1 ##
>+native
>\ No newline at end of property
>Added: svn:mime-type
>## -0,0 +1 ##
>+text/plain
>\ No newline at end of property
>Index: security/py-fido2/files/patch-fido2___pyu2f_____init____.py
>===================================================================
>--- security/py-fido2/files/patch-fido2___pyu2f_____init____.py	(nonexistent)
>+++ security/py-fido2/files/patch-fido2___pyu2f_____init____.py	(working copy)
>@@ -0,0 +1,12 @@
>+--- fido2/_pyu2f/__init__.py.orig	2019-09-10 15:15:37 UTC
>++++ fido2/_pyu2f/__init__.py
>+@@ -47,6 +47,9 @@ def InternalPlatformSwitch(funcname, *args, **kwargs):
>+   elif sys.platform.startswith('darwin'):
>+     from . import macos
>+     clz = macos.MacOsHidDevice
>++  elif sys.platform.startswith('freebsd'):
>++    from . import freebsd
>++    clz = freebsd.FreeBSDHidDevice
>+ 
>+   if not clz:
>+     raise Exception('Unsupported platform: ' + sys.platform)
>
>Property changes on: security/py-fido2/files/patch-fido2___pyu2f_____init____.py
>___________________________________________________________________
>Added: fbsd:nokeywords
>## -0,0 +1 ##
>+yes
>\ No newline at end of property
>Added: svn:eol-style
>## -0,0 +1 ##
>+native
>\ No newline at end of property
>Added: svn:mime-type
>## -0,0 +1 ##
>+text/plain
>\ No newline at end of property
>Index: security/py-fido2/files/patch-fido2___pyu2f_freebsd.py
>===================================================================
>--- security/py-fido2/files/patch-fido2___pyu2f_freebsd.py	(nonexistent)
>+++ security/py-fido2/files/patch-fido2___pyu2f_freebsd.py	(working copy)
>@@ -0,0 +1,57 @@
>+--- fido2/_pyu2f/freebsd.py.orig	2019-09-12 11:35:02 UTC
>++++ fido2/_pyu2f/freebsd.py
>+@@ -0,0 +1,54 @@
>++# Copyright 2016 Google Inc. All Rights Reserved.
>++#
>++# Licensed under the Apache License, Version 2.0 (the "License");
>++# you may not use this file except in compliance with the License.
>++# You may obtain a copy of the License at
>++#
>++#    http://www.apache.org/licenses/LICENSE-2.0
>++#
>++# Unless required by applicable law or agreed to in writing, software
>++# distributed under the License is distributed on an "AS IS" BASIS,
>++# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
>++# See the License for the specific language governing permissions and
>++# limitations under the License.
>++
>++"""Implements raw HID interface on FreeBSD using sysctl and device files."""
>++
>++from __future__ import absolute_import
>++
>++import os
>++import uhid_freebsd
>++
>++from . import linux
>++
>++
>++class FreeBSDHidDevice(linux.LinuxHidDevice):
>++    """Implementation of HID device for FreeBSD.
>++    """
>++
>++    @staticmethod
>++    def Enumerate():
>++        for dev in uhid_freebsd.enumerate():
>++            desc = linux.base.DeviceDescriptor()
>++            desc.path = dev["path"]
>++            desc.vendor_id = dev["vendor_id"]
>++            desc.product_id = dev["product_id"]
>++            desc.product_string = dev["product_desc"]
>++            fd = os.open(desc.path, os.O_RDONLY)
>++            linux.ParseReportDescriptor(
>++                uhid_freebsd.get_report_data(fd, 3), desc)
>++            os.close(fd)
>++            yield desc.ToPublicDict()
>++
>++    def __init__(self, path):
>++        linux.base.HidDevice.__init__(self, path)
>++        self.dev = os.open(path, os.O_RDWR)
>++        self.desc = linux.base.DeviceDescriptor()
>++        self.desc.path = path
>++        linux.ParseReportDescriptor(
>++            uhid_freebsd.get_report_data(self.dev, 3), self.desc)
>++
>++    def Write(self, packet):
>++        """See base class."""
>++        out = bytes(bytearray([0]*64 + packet))  # 64 zero bytes (report ID)
>++        os.write(self.dev, out)
>
>Property changes on: security/py-fido2/files/patch-fido2___pyu2f_freebsd.py
>___________________________________________________________________
>Added: fbsd:nokeywords
>## -0,0 +1 ##
>+yes
>\ No newline at end of property
>Added: svn:eol-style
>## -0,0 +1 ##
>+native
>\ No newline at end of property
>Added: svn:mime-type
>## -0,0 +1 ##
>+text/plain
>\ No newline at end of property
>Index: security/py-fido2/files/patch-setup.cfg
>===================================================================
>--- security/py-fido2/files/patch-setup.cfg	(nonexistent)
>+++ security/py-fido2/files/patch-setup.cfg	(working copy)
>@@ -0,0 +1,8 @@
>+--- setup.cfg.orig	2019-06-17 12:55:37 UTC
>++++ setup.cfg
>+@@ -8,3 +8,5 @@ max-line-length = 80
>+ tag_build = 
>+ tag_date = 0
>+ 
>++[aliases]
>++test=pytest
>
>Property changes on: security/py-fido2/files/patch-setup.cfg
>___________________________________________________________________
>Added: fbsd:nokeywords
>## -0,0 +1 ##
>+yes
>\ No newline at end of property
>Added: svn:eol-style
>## -0,0 +1 ##
>+native
>\ No newline at end of property
>Added: svn:mime-type
>## -0,0 +1 ##
>+text/plain
>\ No newline at end of property
>Index: security/py-fido2/files/patch-setup.py
>===================================================================
>--- security/py-fido2/files/patch-setup.py	(nonexistent)
>+++ security/py-fido2/files/patch-setup.py	(working copy)
>@@ -0,0 +1,23 @@
>+--- setup.py.orig	2019-06-17 10:59:34 UTC
>++++ setup.py
>+@@ -48,13 +48,19 @@ setup(
>+     install_requires=[
>+         'six',
>+         'cryptography>=1.5',
>++        'uhid-freebsd>=1.2.1;platform_system=="FreeBSD"',
>+     ],
>+     extras_require={
>+         ':python_version < "3.4"': ['enum34'],
>+         'pcsc': ['pyscard']
>+     },
>++    setup_requires=['pytest-runner>=2.0'],
>+     test_suite='test',
>+-    tests_require=['mock>=1.0.1', 'pyfakefs>=3.4'],
>++    tests_require=[
>++        'mock>=1.0.1',
>++        'pyfakefs>=3.4;platform_system=="Linux"',
>++        'pytest<5;python_version<"3.5"',
>++        'pytest;python_version>="3.5"'],
>+     classifiers=[
>+         'License :: OSI Approved :: BSD License',
>+         'License :: OSI Approved :: Apache Software License',
>
>Property changes on: security/py-fido2/files/patch-setup.py
>___________________________________________________________________
>Added: fbsd:nokeywords
>## -0,0 +1 ##
>+yes
>\ No newline at end of property
>Added: svn:eol-style
>## -0,0 +1 ##
>+native
>\ No newline at end of property
>Added: svn:mime-type
>## -0,0 +1 ##
>+text/plain
>\ No newline at end of property
>Index: security/py-fido2/files/patch-test___pyu2f_freebsd__test.py
>===================================================================
>--- security/py-fido2/files/patch-test___pyu2f_freebsd__test.py	(nonexistent)
>+++ security/py-fido2/files/patch-test___pyu2f_freebsd__test.py	(working copy)
>@@ -0,0 +1,122 @@
>+--- test/_pyu2f/freebsd_test.py.orig	2019-09-12 12:30:34 UTC
>++++ test/_pyu2f/freebsd_test.py
>+@@ -0,0 +1,119 @@
>++# Copyright 2016 Google Inc. All Rights Reserved.
>++#
>++# Licensed under the Apache License, Version 2.0 (the "License");
>++# you may not use this file except in compliance with the License.
>++# You may obtain a copy of the License at
>++#
>++#    http://www.apache.org/licenses/LICENSE-2.0
>++#
>++# Unless required by applicable law or agreed to in writing, software
>++# distributed under the License is distributed on an "AS IS" BASIS,
>++# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
>++# See the License for the specific language governing permissions and
>++# limitations under the License.
>++
>++"""Tests for _pyu2f.hid.freebsd."""
>++
>++import base64
>++import os
>++import sys
>++
>++import six
>++from six.moves import builtins
>++from mock import patch
>++
>++from fido2._pyu2f import freebsd
>++
>++if sys.version_info[:2] < (2, 7):
>++    import unittest2 as unittest  # pylint: disable=g-import-not-at-top
>++else:
>++    import unittest  # pylint: disable=g-import-not-at-top
>++
>++
>++# These are base64 encoded report descriptors of a Yubico token
>++# and a Logitech keyboard.
>++YUBICO_RD = 'BtDxCQGhAQkgFQAm/wB1CJVAgQIJIRUAJv8AdQiVQJECwA=='
>++KEYBOARD_RD = (
>++    'BQEJAqEBCQGhAAUJGQEpBRUAJQGVBXUBgQKVAXUDgQEFAQkwCTEJOBWBJX91CJUDgQbAwA==')
>++
>++
>++class FakeUhidFreeBSDModule():
>++    def enumerate(self):
>++        return [{'device': 'uhid0',
>++                 'path': '/dev/uhid0',
>++                 'vendor_id': 0x046d,
>++                 'product_id': 0xc31c,
>++                 'product_desc': 'Logitech Keyboard'},
>++                {'device': 'uhid1',
>++                 'path': '/dev/uhid1',
>++                 'vendor_id': 0x1050,
>++                 'product_id': 0x0407,
>++                 'product_desc': 'Yubico U2F'}]
>++
>++    def get_report_data(self, fd, unused_report_id):
>++        if fd:
>++            return base64.b64decode(YUBICO_RD)
>++        else:
>++            return base64.b64decode(KEYBOARD_RD)
>++
>++
>++class FakeOsModule():
>++    O_RDONLY = os.O_RDONLY
>++    O_RDWR = os.O_RDWR
>++    path = os.path
>++
>++    data_written = None
>++    data_to_return = None
>++
>++    def open(self, path, unused_opts):  # pylint: disable=invalid-name
>++        if path.find('uhid1') >= 0:
>++            return 1  # fd == 1 => magic number to return Yubikey RD below
>++        else:
>++            return 0
>++
>++    def write(self, unused_dev, data):  # pylint: disable=invalid-name
>++        self.data_written = data
>++
>++    def read(self, unused_dev, unused_length):  # pylint: disable=invalid-name
>++        return self.data_to_return
>++
>++    def close(self, unused_dev):  # pylint: disable=invalid-name
>++        pass
>++
>++
>++class FreeBSDTest(unittest.TestCase):
>++    @patch('fido2._pyu2f.freebsd.os', FakeOsModule())
>++    @patch('fido2._pyu2f.freebsd.uhid_freebsd', FakeUhidFreeBSDModule())
>++    def testCallEnumerate(self):
>++        devs = list(freebsd.FreeBSDHidDevice.Enumerate())
>++        devs = sorted(devs, key=lambda k: k['vendor_id'])
>++
>++        self.assertEqual(len(devs), 2)
>++        self.assertEqual(devs[0]['vendor_id'], 0x046d)
>++        self.assertEqual(devs[0]['product_id'], 0xc31c)
>++        self.assertEqual(devs[1]['vendor_id'], 0x1050)
>++        self.assertEqual(devs[1]['product_id'], 0x0407)
>++        self.assertEqual(devs[1]['usage_page'], 0xf1d0)
>++        self.assertEqual(devs[1]['usage'], 1)
>++
>++    @patch('fido2._pyu2f.freebsd.uhid_freebsd', FakeUhidFreeBSDModule())
>++    def testCallOpen(self):
>++        fake_os = FakeOsModule()
>++        with patch('fido2._pyu2f.linux.os', fake_os):
>++            with patch('fido2._pyu2f.freebsd.os', fake_os):
>++                dev = freebsd.FreeBSDHidDevice('/dev/uhid1')
>++                self.assertEqual(dev.GetInReportDataLength(), 64)
>++                self.assertEqual(dev.GetOutReportDataLength(), 64)
>++
>++                dev.Write(list(range(0, 64)))
>++                # The HidDevice implementation prepends one zero-byte-packet
>++                # (64 bytes) representing the report ID + padding
>++                self.assertEqual(list(six.iterbytes(fake_os.data_written)),
>++                                 [0]*64 + list(range(0, 64)))
>++
>++                fake_os.data_to_return = b'x' * 64
>++                self.assertEqual(dev.Read(), [120] * 64)  # chr(120) = 'x'
>++
>++
>++if __name__ == '__main__':
>++    unittest.main()
>
>Property changes on: security/py-fido2/files/patch-test___pyu2f_freebsd__test.py
>___________________________________________________________________
>Added: fbsd:nokeywords
>## -0,0 +1 ##
>+yes
>\ No newline at end of property
>Added: svn:eol-style
>## -0,0 +1 ##
>+native
>\ No newline at end of property
>Added: svn:mime-type
>## -0,0 +1 ##
>+text/plain
>\ No newline at end of property
>Index: security/py-fido2/files/patch-test_conftest.py
>===================================================================
>--- security/py-fido2/files/patch-test_conftest.py	(nonexistent)
>+++ security/py-fido2/files/patch-test_conftest.py	(working copy)
>@@ -0,0 +1,12 @@
>+--- test/conftest.py.orig	2019-09-12 15:27:25 UTC
>++++ test/conftest.py
>+@@ -0,0 +1,9 @@
>++import sys
>++
>++collect_ignore = []
>++if not sys.platform.startswith('linux'):
>++    collect_ignore.append('_pyu2f/linux_test.py')
>++if not sys.platform.startswith('darwin'):
>++    collect_ignore.append('_pyu2f/macos_test.py')
>++if not sys.platform.startswith('freebsd'):
>++    collect_ignore.append('_pyu2f/freebsd_test.py')
>
>Property changes on: security/py-fido2/files/patch-test_conftest.py
>___________________________________________________________________
>Added: fbsd:nokeywords
>## -0,0 +1 ##
>+yes
>\ No newline at end of property
>Added: svn:eol-style
>## -0,0 +1 ##
>+native
>\ No newline at end of property
>Added: svn:mime-type
>## -0,0 +1 ##
>+text/plain
>\ No newline at end of property

Actions: View | Diff

Attachments on bug 240476: 207347 | 207433 | 207434 | 207435 | 207436 | 207437 | 207438 | 207439 | 207441 | 207444 | 207445 | 207468 | 207486