############################ Copyrights and license ############################
# #
# Copyright 2012 Vincent Jacques #
# Copyright 2012 Zearin #
# Copyright 2013 AKFish #
# Copyright 2013 Vincent Jacques #
# Copyright 2014 Vincent Jacques #
# Copyright 2016 Jannis Gebauer #
# Copyright 2016 Peter Buckley #
# Copyright 2018 Wan Liuyang #
# Copyright 2018 sfdye #
# Copyright 2019 Steve Kowalik #
# Copyright 2019 Wan Liuyang #
# Copyright 2020 Steve Kowalik #
# Copyright 2021 Chris Keating #
# Copyright 2021 MeggyCal #
# Copyright 2023 Enrico Minack #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Trim21 #
# Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub 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 Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see . #
# #
################################################################################
# https://docs.github.com/en/rest/reference/actions#example-encrypting-a-secret-using-python
from __future__ import annotations
from base64 import b64encode
from typing import Any
from nacl import encoding, public
from github.GithubObject import Attribute, CompletableGithubObject, NotSet
def encrypt(public_key: str, secret_value: str) -> str:
"""
Encrypt a Unicode string using the public key.
"""
pk = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder)
sealed_box = public.SealedBox(pk)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
class PublicKey(CompletableGithubObject):
"""
This class represents either an organization public key or a repository public key.
The reference can be found here
https://docs.github.com/en/rest/reference/actions#get-an-organization-public-key
or here
https://docs.github.com/en/rest/reference/actions#get-a-repository-public-key
"""
def _initAttributes(self) -> None:
self._key_id: Attribute[str | int] = NotSet
self._key: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"key_id": self._key_id.value, "key": self._key.value})
@property
def key(self) -> str:
self._completeIfNotSet(self._key)
return self._key.value
@property
def key_id(self) -> str | int:
self._completeIfNotSet(self._key_id)
return self._key_id.value
def _useAttributes(self, attributes: dict[str, Any]) -> None:
if "key" in attributes: # pragma no branch
self._key = self._makeStringAttribute(attributes["key"])
if "key_id" in attributes: # pragma no branch
if isinstance(attributes["key_id"], str):
self._key_id = self._makeStringAttribute(attributes["key_id"])
else:
self._key_id = self._makeIntAttribute(attributes["key_id"])
def encrypt(self, unencrypted_value: str) -> str:
return encrypt(self._key.value, unencrypted_value)