pyauthenticator 0.1.0__tar.gz → 0.2.1__tar.gz

{pyauthenticator-0.1.0/pyauthenticator.egg-info → pyauthenticator-0.2.1}/PKG-INFO

@@ -1,13 +1,35 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pyauthenticator
-Version: 0.1.0
+Version: 0.2.1
 Summary: Similar to the Google authenticator just written in python.
-Home-page: https://github.com/jan-janssen/pyauthenticator
-Author: Jan Janssen
-Author-email: jan.janssen@outlook.com
-License: BSD
-Description-Content-Type: text/markdown
+Project-URL: Homepage, https://github.com/jan-janssen/pyauthenticator
+Project-URL: Documentation, https://github.com/jan-janssen/pyauthenticator/blob/master/README.md
+Project-URL: Source, https://github.com/jan-janssen/pyauthenticator
+Project-URL: Tracker, https://github.com/jan-janssen/pyauthenticator/issues
+Author-email: Jan Janssen <jan.janssen@outlook.com>
+License: BSD-3-Clause
 License-File: LICENSE
+Keywords: 2FA,MFA,authenticator
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: Utilities
+Requires-Python: >=3.7
+Requires-Dist: pillow>=11.3.0
+Requires-Dist: pyotp>=2.9.0
+Requires-Dist: pyzbar>=0.1.9
+Requires-Dist: qrcode>=8.2
+Description-Content-Type: text/markdown
 
 # pyauthenticator
 [![Python package](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml)
@@ -101,4 +123,4 @@ the config file contains:
 With the Google username `<username>` and the corresponding secret `<secret>` being contained in the QR code.
 
 ## License 
-The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE). 
+The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE). 

{pyauthenticator-0.1.0 → pyauthenticator-0.2.1}/pyauthenticator/__init__.py

@@ -1,11 +1,13 @@
 """
 Generate two factor authentication codes on the command line
 """
-from pyauthenticator.share import (
-    load_config,
-    generate_qrcode,
-    get_two_factor_code as get_two_factor_code_internal,
-)
+
+from . import _version
+from pyauthenticator.share import generate_qrcode
+from pyauthenticator.share import get_two_factor_code as get_two_factor_code_internal
+from pyauthenticator.share import load_config
+
+__version__ = _version.__version__
 
 
 def write_qrcode_to_file(service, file_name=None):

{pyauthenticator-0.1.0 → pyauthenticator-0.2.1}/pyauthenticator/__main__.py

@@ -1,14 +1,16 @@
 """
 Generate two factor authentication codes on the command line
 """
+
 import argparse
 import sys
+
 from pyauthenticator.share import (
-    list_services,
-    load_config,
-    generate_qrcode,
     add_service,
+    generate_qrcode,
     get_two_factor_code,
+    list_services,
+    load_config,
 )
 
 

pyauthenticator-0.2.1/pyauthenticator/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.2.1'
+__version_tuple__ = version_tuple = (0, 2, 1)

{pyauthenticator-0.1.0 → pyauthenticator-0.2.1}/pyauthenticator/share.py

@@ -1,14 +1,15 @@
 """
 Shared functionality to generate two factor authentication codes
 """
-import base64
+
 import json
 import os
-import otpauth
+from inspect import signature
+
+import pyotp
+import qrcode
 from PIL import Image
 from pyzbar.pyzbar import decode
-import qrcode
-
 
 # default configuration file
 config_file = "~/.pyauthenticator"
@@ -75,28 +76,6 @@ def get_otpauth_dict(otpauth_str):
     }
 
 
-def add_padding(main_str, padding_str, padding_length, inverse_padding=False):
-    """
-    Add padding to a string either in the beginning or at the end
-
-    Args:
-        main_str (str): string to add padding to
-        padding_str (str): padding character as string
-        padding_length (int): the length of the final string should be a multiple of the padding length
-        inverse_padding (bool): add padding in the beginning rather than the end
-
-    Returns:
-        str: resulting string with padding
-    """
-    missing_padding = len(main_str) % padding_length
-    if missing_padding:
-        if inverse_padding:
-            main_str = padding_str * (padding_length - missing_padding) + main_str
-        else:
-            main_str += padding_str * (padding_length - missing_padding)
-    return main_str
-
-
 def check_if_key_in_config(key, config_dict):
     """
     Check if a given key is included in a dictionary, raise an ValueError if it is not.
@@ -122,37 +101,25 @@ def get_two_factor_code(key, config_dict):
     """
     check_if_key_in_config(key=key, config_dict=config_dict)
     decode_dict_internal = get_otpauth_dict(otpauth_str=config_dict[key])
+    funct_sig = signature(pyotp.TOTP)
+    if "digits" in decode_dict_internal.keys():
+        digits = int(decode_dict_internal["digits"])
+    else:
+        digits = funct_sig.parameters["digits"].default
     if "period" in decode_dict_internal.keys():
-        totp = otpauth.TOTP(
-            secret=base64.b32decode(
-                add_padding(
-                    main_str=decode_dict_internal["secret"],
-                    padding_str="=",
-                    padding_length=8,
-                    inverse_padding=False,
-                ),
-                True,
-            ),
-            period=int(decode_dict_internal["period"]),
-        )
+        interval = int(decode_dict_internal["period"])
+    else:
+        interval = funct_sig.parameters["interval"].default
+    if "issuer" in decode_dict_internal.keys():
+        issuer = decode_dict_internal["issuer"]
     else:
-        totp = otpauth.TOTP(
-            secret=base64.b32decode(
-                add_padding(
-                    main_str=decode_dict_internal["secret"],
-                    padding_str="=",
-                    padding_length=8,
-                    inverse_padding=False,
-                ),
-                True,
-            ),
-        )
-    return add_padding(
-        main_str=str(totp.string_code(totp.generate())),
-        padding_str="0",
-        padding_length=6,
-        inverse_padding=True,
-    )
+        issuer = funct_sig.parameters["issuer"].default
+    return pyotp.TOTP(
+        s=decode_dict_internal["secret"],
+        digits=digits,
+        issuer=issuer,
+        interval=interval,
+    ).now()
 
 
 def add_service(

pyauthenticator-0.2.1/pyproject.toml

@@ -0,0 +1,75 @@
+[build-system]
+requires = [
+    "hatchling>=1.27.0",
+    "hatch-vcs>=0.5.0",
+    "pyotp>=2.9.0",
+    "qrcode>=8.2",
+    "pyzbar>=0.1.9",
+    "pillow>=11.3.0",
+]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyauthenticator"
+dynamic = ["version"]
+description = "Similar to the Google authenticator just written in python."
+readme = "README.md"
+requires-python = ">=3.7"
+license = { text = "BSD-3-Clause" }
+authors = [
+    { name = "Jan Janssen", email = "jan.janssen@outlook.com" },
+]
+keywords = ["authenticator", "2FA", "MFA"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "pyotp>=2.9.0",
+    "qrcode>=8.2",
+    "pyzbar>=0.1.9",
+    "pillow>=11.3.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/jan-janssen/pyauthenticator"
+Documentation = "https://github.com/jan-janssen/pyauthenticator/blob/master/README.md"
+Source = "https://github.com/jan-janssen/pyauthenticator"
+Tracker = "https://github.com/jan-janssen/pyauthenticator/issues"
+
+[project.scripts]
+pyauthenticator = "pyauthenticator.__main__:command_line_parser"
+
+[tool.hatch.build]
+include = [
+    "pyauthenticator"
+]
+
+[tool.hatch.build.hooks.vcs]
+version-file = "pyauthenticator/_version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "pyauthenticator"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "pyauthenticator"
+]
+
+[tool.hatch.version]
+source = "vcs"
+path = "pyauthenticator/_version.py"

pyauthenticator-0.1.0/MANIFEST.in

@@ -1,3 +0,0 @@
-include LICENSE
-include versioneer.py
-include pyauthenticator/_version.py

pyauthenticator-0.1.0/PKG-INFO

@@ -1,104 +0,0 @@
-Metadata-Version: 2.1
-Name: pyauthenticator
-Version: 0.1.0
-Summary: Similar to the Google authenticator just written in python.
-Home-page: https://github.com/jan-janssen/pyauthenticator
-Author: Jan Janssen
-Author-email: jan.janssen@outlook.com
-License: BSD
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# pyauthenticator
-[![Python package](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/jan-janssen/pyauthenticator/actions/workflows/unittest.yml)
-[![Coverage Status](https://coveralls.io/repos/github/jan-janssen/pyauthenticator/badge.svg?branch=main)](https://coveralls.io/github/jan-janssen/pyauthenticator?branch=main)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-Similar to the Google authenticator just written in Python. With more and more services requiring two factor
-authentication without supporting application specific passwords or other forms of token based authenication
-suitable for automation this python packages allows to generate two factor authentication codes on the commandline
-or in python.
-
-![Preview of pyauthenticator](https://raw.githubusercontent.com/jan-janssen/pyauthenticator/main/pyauthenticator.gif) 
-
-# For Users 
-## Installation
-Install `pyauthenticator` via conda:
-```
->>> conda install -c conda-forge pyauthenticator
-```
-
-Alternatively, `pyauthenticator` can also be installed via pip:
-```
->>> pip install pyauthenticator
-```
-
-## Command Line
-Get help how to use `pyauthenticator` using the `--help/-h` option:
-```
->>> pyauthenticator --help
-
-usage: pyauthenticator [-h] [-qr] [-a ADD] service
-
-positional arguments:
-  service            Service to generate optauth code for. Currently no
-                     service is defined in the ~/.pyauthenticator config file.
-
-options:
-  -h, --help         show this help message and exit
-  -qr, --qrcode      Generate qrcode as <service.png> file.
-  -a ADD, --add ADD  Add service by providing the <qrcode.png> file as
-                     additional argument.
-```
-
-Add `google` as new service after saving the qrcode to `Screenshot 2023-07-02 at 12.45.09.png` to your desktop:
-```
->>> pyauthenticator google --add ~/Desktop/Screenshot\ 2023-07-02\ at\ 12.45.09.png
-
-The service 'google' was added, from file </Users/jan/Desktop/Screenshot 2023-07-02 at 12.45.09.png>
-```
-
-Afterwards, new authentication codes can be generated for the service `google` using:
-```
->>> pyauthenticator google
-
-087078
-```
-Beyond google, `pyauthenticator` works for any service which implements the two factor authentication. 
-
-If you mistype the name of the service, then `pyauthenticator` suggests alternative options:
-```
->>> pyauthenticator googel
-
-The service "googel" does not exist.
-
-The config file ~/.pyauthenticator contains the following services:
-  * google
-
-Choose one of these or add a new service using:
-  pyauthenticator --add <qr-code.png> <servicename>
-```
-
-## Support 
-For any support requests feel free to open an [issue on Github](https://github.com/jan-janssen/pyauthenticator/issues). 
-
-# For Developers 
-## Python Interface
-The same functionality which is available on the command line is also available via the python interface:
-```
-from pyauthenticator import get_two_factor_code
-get_two_factor_code(service)
-```
-So `pyauthenticator` can be integrated in existing python packages which need access to resources protected by two 
-factor authentication. 
-
-## Configuration
-The configuration is stored in `~/.pyauthenticator` it is written in the JSON format. For a given service like `github`
-the config file contains:
-```
-{"google": "otpauth://totp/Google:<username>?secret=<secret>&issuer=Google"}
-```
-With the Google username `<username>` and the corresponding secret `<secret>` being contained in the QR code.
-
-## License 
-The `pyauthenticator` package is licensed under the [BSD-3-Clause license](https://github.com/jan-janssen/pyauthenticator/blob/main/LICENSE). 

pyauthenticator-0.1.0/pyauthenticator/_version.py

@@ -1,21 +0,0 @@
-
-# This file was generated by 'versioneer.py' (0.18) from
-# revision-control system data, or from the parent directory name of an
-# unpacked source archive. Distribution tarballs contain a pre-generated copy
-# of this file.
-
-import json
-
-version_json = '''
-{
- "date": "2023-07-02T14:02:38-0600",
- "dirty": true,
- "error": null,
- "full-revisionid": "6d55f3dd129d29673573d707dbc2119c8f213451",
- "version": "0.1.0"
-}
-'''  # END VERSION_JSON
-
-
-def get_versions():
-    return json.loads(version_json)

pyauthenticator-0.1.0/pyauthenticator.egg-info/SOURCES.txt

@@ -1,20 +0,0 @@
-LICENSE
-MANIFEST.in
-README.md
-setup.cfg
-setup.py
-versioneer.py
-pyauthenticator/__init__.py
-pyauthenticator/__main__.py
-pyauthenticator/_version.py
-pyauthenticator/share.py
-pyauthenticator.egg-info/PKG-INFO
-pyauthenticator.egg-info/SOURCES.txt
-pyauthenticator.egg-info/dependency_links.txt
-pyauthenticator.egg-info/entry_points.txt
-pyauthenticator.egg-info/requires.txt
-pyauthenticator.egg-info/top_level.txt
-tests/test_cmd.py
-tests/test_core.py
-tests/test_share.py
-tests/test_user_interface.py

pyauthenticator-0.1.0/pyauthenticator.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

pyauthenticator-0.1.0/pyauthenticator.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-pyauthenticator = pyauthenticator.__main__:command_line_parser

pyauthenticator-0.1.0/pyauthenticator.egg-info/requires.txt

@@ -1,4 +0,0 @@
-otpauth>=2.0.0
-qrcode>=7.4.2
-pyzbar>=0.1.9
-pillow>=9.5.0

pyauthenticator-0.1.0/pyauthenticator.egg-info/top_level.txt

@@ -1 +0,0 @@
-pyauthenticator

pyauthenticator-0.1.0/setup.cfg

@@ -1,11 +0,0 @@
-[versioneer]
-VCS = git
-style = pep440-pre
-versionfile_source = pyauthenticator/_version.py
-tag_prefix = pyauthenticator-
-parentdir_prefix = pyauthenticator
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

pyauthenticator-0.1.0/setup.py

@@ -1,31 +0,0 @@
-"""
-Setuptools based setup module
-"""
-from setuptools import setup, find_packages
-import versioneer
-
-
-setup(
-    name='pyauthenticator',
-    version=versioneer.get_version(),
-    description='Similar to the Google authenticator just written in python.',
-    long_description=open('README.md').read(),
-    long_description_content_type="text/markdown",
-    url='https://github.com/jan-janssen/pyauthenticator',
-    author='Jan Janssen',
-    author_email='jan.janssen@outlook.com',
-    license='BSD',
-    packages=find_packages(exclude=["*tests*"]),
-    install_requires=[
-        'otpauth>=2.0.0',
-        'qrcode>=7.4.2',
-        'pyzbar>=0.1.9',
-        'pillow>=9.5.0',
-    ],
-    cmdclass=versioneer.get_cmdclass(),
-    entry_points={
-        "console_scripts": [
-            'pyauthenticator=pyauthenticator.__main__:command_line_parser'
-        ]
-    }
-)

pyauthenticator-0.1.0/tests/test_cmd.py

@@ -1,88 +0,0 @@
-import unittest
-import os
-import subprocess
-import json
-from contextlib import redirect_stdout
-from io import StringIO
-from pyauthenticator.share import expand_path, write_config, config_file
-from pyauthenticator.__main__ import command_line_parser
-
-
-class CmdSubprocessTest(unittest.TestCase):
-    @classmethod
-    def setUpClass(cls):
-        cls.config_dict = {
-            "test": "otpauth://totp/Test%3A%20root%40github.com?secret=6IQXETC4ADOSMMUN&issuer=Test"
-        }
-        cls.config_path = expand_path(config_file)
-        if not os.path.exists(cls.config_path):
-            write_config(
-                config_dict=cls.config_dict
-            )
-
-    def test_main_generate_two_factor(self):
-        code = subprocess.check_output(
-            ["coverage", "run", "-a", "pyauthenticator", "test"],
-            universal_newlines=True
-        )
-        self.assertEqual(len(code.replace("\n", "")), 6)
-
-    def test_main_generate_qr_code(self):
-        subprocess.check_output(
-            ["coverage", "run", "-a", "pyauthenticator", "-qr", "test"],
-            universal_newlines=True
-        )
-        self.assertTrue(os.path.exists("test.png"))
-        subprocess.check_output(
-            ["coverage", "run", "-a", "pyauthenticator", "-a", "test.png", "test2"],
-            universal_newlines=True
-        )
-        with open(self.config_path, "r") as f:
-            config_dict = json.load(f)
-        self.assertTrue("test2" in config_dict.keys())
-
-
-class CmdParserTest(unittest.TestCase):
-    @classmethod
-    def setUpClass(cls):
-        cls.config_dict = {
-            "test": "otpauth://totp/Test%3A%20root%40github.com?secret=6IQXETC4ADOSMMUN&issuer=Test"
-        }
-        cls.config_path = expand_path(config_file)
-        if not os.path.exists(cls.config_path):
-            write_config(
-                config_dict=cls.config_dict
-            )
-
-    def test_main_generate_two_factor(self):
-        with redirect_stdout(StringIO()) as sout:
-            command_line_parser(cmd_args=["test"])
-        self.assertEqual(len(sout.getvalue().rstrip('\n')), 6)
-        with redirect_stdout(StringIO()) as sout:
-            command_line_parser(cmd_args=["test3"])
-        self.assertEqual(
-            sout.getvalue().split("\n")[0],
-            "The service \"test3\" does not exist."
-        )
-
-    def test_main_generate_qr_code(self):
-        with redirect_stdout(StringIO()) as sout:
-            command_line_parser(cmd_args=["-qr", "test"])
-        self.assertEqual(
-            sout.getvalue(),
-            "The qrcode file <test.png> was generated.\n"
-        )
-        self.assertTrue(os.path.exists("test.png"))
-        with redirect_stdout(StringIO()) as sout:
-            command_line_parser(cmd_args=["-a", "test.png", "test4"])
-        self.assertEqual(
-            sout.getvalue(),
-            "The service 'test4' was added, from file <test.png>.\n"
-        )
-        with open(self.config_path, "r") as f:
-            config_dict = json.load(f)
-        self.assertTrue("test4" in config_dict.keys())
-
-
-if __name__ == '__main__':
-    unittest.main()

pyauthenticator-0.1.0/tests/test_core.py

@@ -1,48 +0,0 @@
-"""
-Test for core functionality
-"""
-import unittest
-from pyauthenticator.share import list_services, load_config, generate_qrcode, add_service, get_two_factor_code
-import os
-
-
-class TestCore(unittest.TestCase):
-    @classmethod
-    def setUpClass(cls):
-        cls.qr_code_png = "test.png"
-        cls.config_dict = {
-            "test": "otpauth://totp/Test%3A%20root%40github.com?secret=6IQXETC4ADOSMMUN&issuer=Test&period=60"
-        }
-        generate_qrcode(
-            key="test",
-            config_dict=cls.config_dict,
-            file_name=None
-        )
-
-    @classmethod
-    def tearDownClass(cls):
-        os.remove(cls.qr_code_png)
-
-    def test_list_services(self):
-        service_lst = list_services(config_dict=self.config_dict)
-        self.assertEqual(["test"], service_lst)
-
-    def test_add_service(self):
-        config_file = "test_config.json"
-        add_service(
-            key="test",
-            qrcode_png_file_name=self.qr_code_png,
-            config_dict={},
-            config_file_to_write=config_file
-        )
-        config_reload = load_config(config_file_to_load=config_file)
-        self.assertDictEqual(config_reload, self.config_dict)
-        os.remove(config_file)
-
-    def test_get_two_factor_code(self):
-        code = get_two_factor_code(key="test", config_dict=self.config_dict)
-        self.assertEqual(len(code), 6)
-
-
-if __name__ == '__main__':
-    unittest.main()