Skip to content

aria2_server.cli.utils.mkcert

__all__ module-attribute 

__all__ = ('mkcert_cli')

mkcert_cli module-attribute 

mkcert_cli = Typer(invoke_without_command=True)

mkcert 

mkcert(
    san: List[str],
    *,
    key_file: Path = Path("key.pem"),
    cert_file: Path = Path("cert.crt"),
    key_file_password: str = "",
    expiration_days: int = 365,
    organization_name: str = "Aria2 Server"
)

Generate a self-signed certificate for https server.

Source code in src/aria2_server/cli/utils/mkcert.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
@mkcert_cli.callback()
def mkcert(
    san: Annotated[
        List[str],
        typer.Argument(
            help=dedent(
                """\
                Subject Alternative Names (SAN). Only support IP address and DNS name.
                e.g: `192.168.137.1`, `localhost`\
            """
            ),
        ),
    ],
    *,
    key_file: Annotated[
        Path,
        typer.Option(
            help="Path to the private key file which will be created.",
            prompt=True,
            dir_okay=False,
            writable=True,
            allow_dash=True,
        ),
    ] = Path("key.pem"),
    cert_file: Annotated[
        Path,
        typer.Option(
            help="Path to the certificate file which will be created.",
            prompt=True,
            dir_okay=False,
            writable=True,
            allow_dash=True,
        ),
    ] = Path("cert.crt"),
    key_file_password: Annotated[
        str,
        typer.Option(
            help=dedent(
                """\
                Password for the private key file.
                If not specified, will create a private key file without password.
                For security reasons, we strongly recommend setting a password for the private key file.\
            """
            ),
            prompt=True,
        ),
    ] = "",
    expiration_days: Annotated[
        int,
        typer.Option(
            help="The number of days the certificate will be valid for.",
            prompt=True,
        ),
    ] = 365,
    organization_name: Annotated[
        str,
        typer.Option(
            help="Organization name for the certificate.",
            prompt=True,
        ),
    ] = "Aria2 Server",
):
    """Generate a self-signed certificate for https server."""
    # Generate our key
    key = rsa.generate_private_key(
        public_exponent=65537,
        key_size=2048,
    )
    # Write our key to disk for safe keeping
    encryption_algorithm = (
        serialization.BestAvailableEncryption(key_file_password.encode("utf-8"))
        if key_file_password
        else serialization.NoEncryption()
    )
    with typer.open_file(str(key_file), "wb") as f:
        f.write(
            key.private_bytes(
                encoding=serialization.Encoding.PEM,
                format=serialization.PrivateFormat.TraditionalOpenSSL,
                encryption_algorithm=encryption_algorithm,
            )
        )

    # Various details about who we are. For a self-signed certificate the
    # subject and issuer are always the same.
    subject = issuer = x509.Name(
        [
            # x509.NameAttribute(NameOID.COUNTRY_NAME, "US"),
            # x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, "California"),
            # x509.NameAttribute(NameOID.LOCALITY_NAME, "San Francisco"),
            x509.NameAttribute(NameOID.ORGANIZATION_NAME, organization_name),
            # x509.NameAttribute(NameOID.COMMON_NAME, "aria2-server.com"),
        ]
    )
    cert = (
        x509.CertificateBuilder()
        .subject_name(subject)
        .issuer_name(issuer)
        .public_key(key.public_key())
        .serial_number(x509.random_serial_number())
        .not_valid_before(datetime.datetime.now(datetime.timezone.utc))
        .not_valid_after(
            datetime.datetime.now(datetime.timezone.utc)
            + datetime.timedelta(days=expiration_days)
        )
        .add_extension(
            x509.SubjectAlternativeName([_parse_san_type(_) for _ in san]),
            critical=False,
        )
        # Sign our certificate with our private key
        .sign(key, hashes.SHA256())
    )
    # Write our certificate out to disk.
    with typer.open_file(str(cert_file), "wb") as f:
        f.write(cert.public_bytes(serialization.Encoding.PEM))