funsecret 1.3.2__tar.gz

funsecret-1.3.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [2023] [niuliangtao]
+
+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.

funsecret-1.3.2/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: funsecret
+Version: 1.3.2
+Summary: 
+Author: farfun
+Author-email: 1007530194@qq.com
+Requires-Python: >=3.6,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+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
+Requires-Dist: fundrive (>=0.12.29,<0.13.0)
+Description-Content-Type: text/markdown
+
+# funsecret
+
+## 安装
+
+```bash
+pip install funsecret
+```
+
+## 写入或者更新
+
+```python
+from funsecret import read_secret, write_secret
+
+write_secret("your username", "wechat", "login", "username")
+read_secret("wechat", "login", "username", value="your username")
+```
+
+## 读取
+
+```python
+from funsecret import read_secret
+
+username = read_secret("wechat", "login", "username")
+password = read_secret("wechat", "login", "password")
+```
+
+## 快照
+
+快照功能需要单独安装
+
+```bash
+pip install funsecret_snapshot
+```
+
+目前只支持保存 lanzou
+
+### 保存
+
+```python
+from funsecret_snapshot import save_snapshot
+
+bin_id = '**'
+cipher_key = '******'
+security_key = "******"
+save_snapshot(bin_id, cipher_key, security_key)
+```
+
+### 读取
+
+```python
+from funsecret_snapshot import load_snapshot
+
+bin_id = '**'
+cipher_key = '******'
+security_key = "******"
+load_snapshot(bin_id, cipher_key, security_key)
+```
+

funsecret-1.3.2/README.md

@@ -0,0 +1,57 @@
+# funsecret
+
+## 安装
+
+```bash
+pip install funsecret
+```
+
+## 写入或者更新
+
+```python
+from funsecret import read_secret, write_secret
+
+write_secret("your username", "wechat", "login", "username")
+read_secret("wechat", "login", "username", value="your username")
+```
+
+## 读取
+
+```python
+from funsecret import read_secret
+
+username = read_secret("wechat", "login", "username")
+password = read_secret("wechat", "login", "password")
+```
+
+## 快照
+
+快照功能需要单独安装
+
+```bash
+pip install funsecret_snapshot
+```
+
+目前只支持保存 lanzou
+
+### 保存
+
+```python
+from funsecret_snapshot import save_snapshot
+
+bin_id = '**'
+cipher_key = '******'
+security_key = "******"
+save_snapshot(bin_id, cipher_key, security_key)
+```
+
+### 读取
+
+```python
+from funsecret_snapshot import load_snapshot
+
+bin_id = '**'
+cipher_key = '******'
+security_key = "******"
+load_snapshot(bin_id, cipher_key, security_key)
+```

funsecret-1.3.2/funsecret/__init__.py

@@ -0,0 +1,10 @@
+from .fernet import decrypt, encrypt, generate_key, get_md5_file, get_md5_str, file_decrypt, file_encrypt
+from .secret import (
+    SecretManage,
+    SecretTable,
+    load_secret_str,
+    read_secret,
+    save_secret_str,
+    write_secret,
+    load_os_environ,
+)

funsecret-1.3.2/funsecret/fernet.py

@@ -0,0 +1,85 @@
+import hashlib
+
+from cryptography.fernet import Fernet
+
+
+def generate_key():
+    return Fernet.generate_key().decode()
+
+
+def encrypt(text, cipher_key=None):
+    """
+    加密，我也没测试过，不知道能不能正常使用，纯字母的应该没问题，中文的待商榷
+    :param text: 需要加密的文本
+    :param cipher_key: 加密key
+    :return: 加密后的文本
+    """
+    if cipher_key is None or text is None:
+        return text
+    cipher = Fernet(bytes(cipher_key, encoding="utf8"))
+    return cipher.encrypt(text.encode()).decode()
+
+
+def file_encrypt(src_path, dst_path=None, cipher_key=None):
+    if cipher_key is None:
+        raise Exception("cipher_key cannot be None.")
+    cipher = Fernet(bytes(cipher_key, encoding="utf8"))
+    if dst_path is None:
+        dst_path = src_path + ".crypt"
+    with open(dst_path, "wb") as fw:
+        with open(src_path, "rb") as fr:
+            fw.write(cipher.encrypt(fr.read()))
+    return dst_path
+
+
+def file_decrypt(src_path, dst_path=None, cipher_key=None):
+    if cipher_key is None:
+        raise Exception("cipher_key cannot be None.")
+    cipher = Fernet(bytes(cipher_key, encoding="utf8"))
+    if dst_path is None and src_path.endswith(".crypt"):
+        dst_path = src_path.replace(".crypt", "")
+    if dst_path is None:
+        raise Exception("dst_path cannot be None.")
+    with open(dst_path, "wb") as fw:
+        with open(src_path, "rb") as fr:
+            fw.write(cipher.decrypt(fr.read()))
+    return dst_path
+
+
+def decrypt(encrypted_text, cipher_key=None):
+    """
+    解密，我也没测试过，不知道能不能正常使用，纯字母的应该没问题，中文的待商榷
+    :param cipher_key: 加密key
+    :param encrypted_text: 需要解密的文本
+    :return:解密后的文本
+    """
+    if cipher_key is None or encrypted_text is None:
+        return encrypted_text
+    cipher = Fernet(bytes(cipher_key, encoding="utf8"))
+    try:
+        return cipher.decrypt(bytes(encrypted_text, encoding="utf8")).decode()
+    except Exception as e:
+        return encrypted_text
+
+
+def get_md5_str(strs: str):
+    """
+    计算字符串md5值
+    :param strs: 输入字符串
+    :return: 字符串md5
+    """
+    m = hashlib.md5()
+    m.update(strs.encode())
+    return m.hexdigest()
+
+
+def get_md5_file(path, chunk=1024 * 4):
+    m = hashlib.md5()
+    with open(path, "rb") as f:
+        while True:
+            data = f.read(chunk)
+            if not data:
+                break
+            m.update(data)
+
+    return m.hexdigest()

funsecret-1.3.2/funsecret/secret.py

@@ -0,0 +1,211 @@
+import json
+import logging
+import os
+import pickle
+import time
+from datetime import datetime
+
+from fundb.json import JSONStorage
+from fundb.sqlalchemy import BaseTable, create_engine, create_engine_sqlite, Base
+from funsecret.fernet import decrypt, encrypt
+from sqlalchemy import BIGINT, String, create_engine, select, UniqueConstraint, delete
+from sqlalchemy.orm import mapped_column
+
+local_secret_path = "~/.secret"
+logger = logging.getLogger("funsecret")
+
+
+def set_secret_path(path):
+    global local_secret_path
+    local_secret_path = path
+
+
+class SecretTable(Base):
+    __tablename__ = "secret_manage"
+    __table_args__ = (UniqueConstraint("cate1", "cate2", "cate3", "cate4", "cate5"),)
+
+    cate1 = mapped_column(String(100), comment="一级分类", default="", primary_key=True)
+    cate2 = mapped_column(String(100), comment="二级分类", default="", primary_key=True)
+    cate3 = mapped_column(String(100), comment="三级分类", default="", primary_key=True)
+    cate4 = mapped_column(String(100), comment="四级分类", default="", primary_key=True)
+    cate5 = mapped_column(String(100), comment="五级分类", default="", primary_key=True)
+    value = mapped_column(String(100), comment="值", default="")
+
+    expire_time = mapped_column(BIGINT, comment="过期时间", default=9999999999)
+
+
+class SecretManage(BaseTable):
+    def __init__(self, secret_dir=None, url=None, cipher_key=None, *args, **kwargs):
+        self.cipher_key = cipher_key
+        if url is not None:
+            uri = url
+            engine = create_engine(uri)
+        else:
+            secret_dir = secret_dir or local_secret_path
+            secret_dir = secret_dir.replace("~", os.environ.get("FUN_SECRET_PATH", os.environ["HOME"]))
+            if not os.path.exists(secret_dir):
+                os.makedirs(secret_dir)
+            engine = create_engine_sqlite(f"{secret_dir}/.funsecret.db")
+        super(SecretManage, self).__init__(table=SecretTable, engine=engine, *args, **kwargs)
+
+    def encrypt(self, text):
+        """
+        加密，我也没测试过，不知道能不能正常使用，纯字母的应该没问题，中文的待商榷
+        :param text: 需要加密的文本
+        :return: 加密后的文本
+        """
+        return encrypt(text, self.cipher_key)
+
+    def decrypt(self, encrypted_text):
+        """
+        解密，我也没测试过，不知道能不能正常使用，纯字母的应该没问题，中文的待商榷
+        :param encrypted_text: 需要解密的文本
+        :return:解密后的文本
+        """
+        return decrypt(encrypted_text, self.cipher_key)
+
+    def read(self, cate1, cate2, cate3="", cate4="", cate5="", value=None, save=True, secret=False, expire_time=None):
+        """
+        按照分类读取保存的key，如果为空或者已过期，则返回None
+        :param cate1: cate1
+        :param cate2: cate2
+        :param cate3: cate3
+        :param cate4: cate4
+        :param cate5: cate5
+        :param value: 保存的数据
+        :param save: 是否需要保存，保存的话，会覆盖当前保存的数据
+        :param secret: 是否需要加密，如果加密的话，构造类的时候，cipher_key不能为空，这是加密解密的秘钥
+        :param expire_time: 过期时间，unix时间戳，如果小于10000000的话，会当做保存数据的持续时间，加上当前的Unix时间戳作为过期时间
+        :return: 保存的数据
+        """
+        if expire_time is not None and expire_time < 1000000000:
+            expire_time += int(time.time())
+        if save:
+            self.write(value, cate1, cate2, cate3, cate4, cate5, secret=secret, expire_time=expire_time)
+        if value is not None:
+            return value
+
+        self.execute(delete(SecretTable).where(SecretTable.expire_time < time.time()))
+
+        sql = select(SecretTable.value, SecretTable.expire_time).where(
+            SecretTable.cate1 == cate1,
+            SecretTable.cate2 == cate2,
+            SecretTable.cate3 == cate3,
+            SecretTable.cate4 == cate4,
+            SecretTable.cate5 == cate5,
+        )
+        data = [line for line in self.execute(sql)]
+        if len(data) > 0:
+            value, expire_time = data[0]
+            if secret:
+                value = self.decrypt(value)
+            if expire_time is None or expire_time == "None" or int(time.time()) < expire_time:
+                return value
+
+        return None
+
+    def write(self, value, cate1, cate2="", cate3="", cate4="", cate5="", secret=False, expire_time=99999999):
+        """
+        对数据进行保存
+        :param value: 保存的数据
+        :param cate1:cate1
+        :param cate2:cate2
+        :param cate3:cate3
+        :param cate4:cate4
+        :param cate5:cate5
+        :param secret: 是否需要加密
+        :param expire_time:过期时间，默认不过期
+        """
+        if value is None:
+            return
+        if expire_time is not None and expire_time < 1000000000:
+            expire_time += int(time.time())
+        if secret:
+            value = self.encrypt(value)
+
+        properties = {
+            "cate1": cate1,
+            "cate2": cate2,
+            "cate3": cate3,
+            "cate4": cate4,
+            "cate5": cate5,
+            "value": value,
+            "expire_time": expire_time,
+        }
+
+        self.upsert(values=properties)
+
+    def save_secret_str(self, path="~/.secret/secret_str", cipher_key=None):
+        path = path.replace("~", os.environ["HOME"])
+        res = []
+        all_data = self.select_all()
+        if cipher_key is not None:
+            all_data["value"] = all_data["value"].apply(lambda x: encrypt(x, cipher_key))
+        with open(path, "wb") as fw:
+            pickle.dump(all_data, fw)
+
+        return res
+
+    def load_secret_str(self, all_data=None, path="~/.secret/secret_str", cipher_key=None):
+        path = path.replace("~", os.environ["HOME"])
+        if all_data is None:
+            if not os.path.exists(path):
+                print(f"{path} is not exists.")
+                return
+            with open(path, "rb") as fr:
+                all_data = pickle.load(fr)
+        all_data["value"] = all_data["value"].apply(lambda x: decrypt(x, cipher_key))
+        for line in json.loads(all_data.to_json(orient="records")):
+            self.write(**line)
+
+
+def read_secret(cate1, cate2, cate3="", cate4="", cate5="", value=None, save=True, secret=False, expire_time=9999999):
+    manage = SecretManage()
+    value = manage.read(
+        cate1=cate1,
+        cate2=cate2,
+        cate3=cate3,
+        cate4=cate4,
+        cate5=cate5,
+        value=value,
+        save=save,
+        secret=secret,
+        expire_time=expire_time,
+    )
+    if value is None:
+        logger.debug(f"not found value from {cate1}/{cate2}/{cate3}/{cate4}/{cate5}")
+    return value
+
+
+def write_secret(value, cate1, cate2="", cate3="", cate4="", cate5="", secret=False, expire_time=9999999):
+    manage = SecretManage()
+    manage.write(
+        value=value,
+        cate1=cate1,
+        cate2=cate2,
+        cate3=cate3,
+        cate4=cate4,
+        cate5=cate5,
+        secret=secret,
+        expire_time=expire_time,
+    )
+
+
+def save_secret_str(path="~/.secret/secret_str"):
+    return SecretManage().save_secret_str(path)
+
+
+def load_secret_str(secret_str=None, path="~/.secret/secret_str"):
+    SecretManage().load_secret_str(secret_str, path)
+
+
+def load_os_environ():
+    manage = SecretManage()
+    for k, v in os.environ.items():
+        manage.read(cate1="os", cate2="environ", cate3=k, value=v)
+
+
+def save_os_environ():
+    manage = SecretManage()
+    for k, v in os.environ.items():
+        manage.read(cate1="os", cate2="environ", cate3=k, value=v)

funsecret-1.3.2/pyproject.toml

@@ -0,0 +1,14 @@
+[build-system]
+requires = [ "poetry-core",]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "funsecret"
+version = "1.3.2"
+description = ""
+authors = [ "farfun <1007530194@qq.com>",]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.6"
+fundrive = "^0.12.29"