| | | |
Offset 34, 112 lines modified | Offset 34, 112 lines modified |
34 | Contents: | 34 | Contents: |
35 | .SH·API·DOCUMENTATION | 35 | .SH·API·DOCUMENTATION |
36 | .SS·Challenges | 36 | .SS·Challenges |
37 | .sp | 37 | .sp |
38 | ACME·Identifier·Validation·Challenges. | 38 | ACME·Identifier·Validation·Challenges. |
39 | .INDENT·0.0 | 39 | .INDENT·0.0 |
40 | .TP | 40 | .TP |
41 | .B·class·acme.challenges.Challenge(**kwargs:·\fI\%Any\fP) | 41 | .B·class·acme.challenges.Challenge(**kwargs:·Any) |
42 | ACME·challenge. | 42 | ACME·challenge. |
43 | .INDENT·7.0 | 43 | .INDENT·7.0 |
44 | .TP | 44 | .TP |
45 | .B·TYPES:·\fI\%Dict\fP[\fI\%str\fP,·\fI\%Type\fP[\fI\%Challenge\fP]]·=·{\(aqdns\(aq:·<class·\(aqacme.challenges.DNS\(aq>,·\(aqdns\-01\(aq:·<class·\(aqacme.challenges.DNS01\(aq>,·\(aqhttp\-01\(aq:·<class·\(aqacme.challenges.HTTP01\(aq>,·\(aqtls\-alpn\-01\(aq:·<class·\(aqacme.challenges.TLSALPN01\(aq>} | 45 | .B·TYPES:·Dict[str,·Type[\fI\%Challenge\fP]]·=·{\(aqdns\(aq:·<class·\(aqacme.challenges.DNS\(aq>,·\(aqdns\-01\(aq:·<class·\(aqacme.challenges.DNS01\(aq>,·\(aqhttp\-01\(aq:·<class·\(aqacme.challenges.HTTP01\(aq>,·\(aqtls\-alpn\-01\(aq:·<class·\(aqacme.challenges.TLSALPN01\(aq>} |
46 | Types·registered·for·JSON·deserialization | 46 | Types·registered·for·JSON·deserialization |
47 | .UNINDENT | 47 | .UNINDENT |
48 | .INDENT·7.0 | 48 | .INDENT·7.0 |
49 | .TP | 49 | .TP |
50 | .B·classmethod·from_json(jobj:·\fI\%Mapping\fP[\fI\%str\fP,·\fI\%Any\fP])·->·GenericChallenge·|·\fI\%UnrecognizedChallenge\fP | 50 | .B·classmethod·from_json(jobj:·Mapping[str,·Any])·->·GenericChallenge·|·\fI\%UnrecognizedChallenge\fP |
51 | Deserialize·ACME·object·from·valid·JSON·object. | 51 | Deserialize·ACME·object·from·valid·JSON·object. |
52 | .INDENT·7.0 | 52 | .INDENT·7.0 |
53 | .TP | 53 | .TP |
54 | .B·Raises | 54 | .B·Raises |
55 | \fI\%josepy.errors.UnrecognizedTypeError\fP·\-\-·if·type | 55 | \fBjosepy.errors.UnrecognizedTypeError\fP·\-\-·if·type |
56 | of·the·ACME·object·has·not·been·registered. | 56 | of·the·ACME·object·has·not·been·registered. |
57 | .UNINDENT | 57 | .UNINDENT |
58 | .UNINDENT | 58 | .UNINDENT |
59 | .UNINDENT | 59 | .UNINDENT |
60 | .INDENT·0.0 | 60 | .INDENT·0.0 |
61 | .TP | 61 | .TP |
62 | .B·class·acme.challenges.ChallengeResponse(**kwargs:·\fI\%Any\fP) | 62 | .B·class·acme.challenges.ChallengeResponse(**kwargs:·Any) |
63 | ACME·challenge·response. | 63 | ACME·challenge·response. |
64 | .INDENT·7.0 | 64 | .INDENT·7.0 |
65 | .TP | 65 | .TP |
66 | .B·TYPES:·\fI\%Dict\fP[\fI\%str\fP,·\fI\%Type\fP[\fI\%ChallengeResponse\fP]]·=·{\(aqdns\(aq:·<class·\(aqacme.challenges.DNSResponse\(aq>,·\(aqdns\-01\(aq:·<class·\(aqacme.challenges.DNS01Response\(aq>,·\(aqhttp\-01\(aq:·<class·\(aqacme.challenges.HTTP01Response\(aq>,·\(aqtls\-alpn\-01\(aq:·<class·\(aqacme.challenges.TLSALPN01Response\(aq>} | 66 | .B·TYPES:·Dict[str,·Type[\fI\%ChallengeResponse\fP]]·=·{\(aqdns\(aq:·<class·\(aqacme.challenges.DNSResponse\(aq>,·\(aqdns\-01\(aq:·<class·\(aqacme.challenges.DNS01Response\(aq>,·\(aqhttp\-01\(aq:·<class·\(aqacme.challenges.HTTP01Response\(aq>,·\(aqtls\-alpn\-01\(aq:·<class·\(aqacme.challenges.TLSALPN01Response\(aq>} |
67 | Types·registered·for·JSON·deserialization | 67 | Types·registered·for·JSON·deserialization |
68 | .UNINDENT | 68 | .UNINDENT |
69 | .INDENT·7.0 | 69 | .INDENT·7.0 |
70 | .TP | 70 | .TP |
71 | .B·to_partial_json()·->·\fI\%Dict\fP[\fI\%str\fP,·\fI\%Any\fP] | 71 | .B·to_partial_json()·->·Dict[str,·Any] |
72 | Get·JSON·serializable·object. | 72 | Get·JSON·serializable·object. |
73 | .INDENT·7.0 | 73 | .INDENT·7.0 |
74 | .TP | 74 | .TP |
75 | .B·Returns | 75 | .B·Returns |
76 | Serializable·JSON·object·representing·ACME·typed·object. | 76 | Serializable·JSON·object·representing·ACME·typed·object. |
77 | \fBvalidate()\fP·will·almost·certainly·not·work,·due·to·reasons | 77 | \fBvalidate()\fP·will·almost·certainly·not·work,·due·to·reasons |
78 | explained·in·\fBjosepy.interfaces.IJSONSerializable\fP\&. | 78 | explained·in·\fBjosepy.interfaces.IJSONSerializable\fP\&. |
79 | .TP | 79 | .TP |
80 | .B·Return·type | 80 | .B·Return·type |
81 | \fI\%dict\fP | 81 | dict |
82 | .UNINDENT | 82 | .UNINDENT |
83 | .UNINDENT | 83 | .UNINDENT |
84 | .UNINDENT | 84 | .UNINDENT |
85 | .INDENT·0.0 | 85 | .INDENT·0.0 |
86 | .TP | 86 | .TP |
87 | .B·class·acme.challenges.UnrecognizedChallenge(jobj:·\fI\%Mapping\fP[\fI\%str\fP,·\fI\%Any\fP]) | 87 | .B·class·acme.challenges.UnrecognizedChallenge(jobj:·Mapping[str,·Any]) |
88 | Unrecognized·challenge. | 88 | Unrecognized·challenge. |
89 | .sp | 89 | .sp |
90 | ACME·specification·defines·a·generic·framework·for·challenges·and | 90 | ACME·specification·defines·a·generic·framework·for·challenges·and |
91 | defines·some·standard·challenges·that·are·implemented·in·this | 91 | defines·some·standard·challenges·that·are·implemented·in·this |
92 | module.·However,·other·implementations·(including·peers)·might | 92 | module.·However,·other·implementations·(including·peers)·might |
93 | define·additional·challenge·types,·which·should·be·ignored·if | 93 | define·additional·challenge·types,·which·should·be·ignored·if |
94 | unrecognized. | 94 | unrecognized. |
95 | .INDENT·7.0 | 95 | .INDENT·7.0 |
96 | .TP | 96 | .TP |
97 | .B·Variables | 97 | .B·Variables |
98 | \fBjobj\fP·\-\-·Original·JSON·decoded·object. | 98 | \fBjobj\fP·\-\-·Original·JSON·decoded·object. |
99 | .UNINDENT | 99 | .UNINDENT |
100 | .INDENT·7.0 | 100 | .INDENT·7.0 |
101 | .TP | 101 | .TP |
102 | .B·to_partial_json()·->·\fI\%Dict\fP[\fI\%str\fP,·\fI\%Any\fP] | 102 | .B·to_partial_json()·->·Dict[str,·Any] |
103 | Get·JSON·serializable·object. | 103 | Get·JSON·serializable·object. |
104 | .INDENT·7.0 | 104 | .INDENT·7.0 |
105 | .TP | 105 | .TP |
106 | .B·Returns | 106 | .B·Returns |
107 | Serializable·JSON·object·representing·ACME·typed·object. | 107 | Serializable·JSON·object·representing·ACME·typed·object. |
108 | \fBvalidate()\fP·will·almost·certainly·not·work,·due·to·reasons | 108 | \fBvalidate()\fP·will·almost·certainly·not·work,·due·to·reasons |
109 | explained·in·\fBjosepy.interfaces.IJSONSerializable\fP\&. | 109 | explained·in·\fBjosepy.interfaces.IJSONSerializable\fP\&. |
110 | .TP | 110 | .TP |
111 | .B·Return·type | 111 | .B·Return·type |
112 | \fI\%dict\fP | 112 | dict |
113 | .UNINDENT | 113 | .UNINDENT |
114 | .UNINDENT | 114 | .UNINDENT |
115 | .INDENT·7.0 | 115 | .INDENT·7.0 |
116 | .TP | 116 | .TP |
117 | .B·classmethod·from_json(jobj:·\fI\%Mapping\fP[\fI\%str\fP,·\fI\%Any\fP])·->·\fI\%UnrecognizedChallenge\fP | 117 | .B·classmethod·from_json(jobj:·Mapping[str,·Any])·->·\fI\%UnrecognizedChallenge\fP |
118 | Deserialize·ACME·object·from·valid·JSON·object. | 118 | Deserialize·ACME·object·from·valid·JSON·object. |
119 | .INDENT·7.0 | 119 | .INDENT·7.0 |
120 | .TP | 120 | .TP |
121 | .B·Raises | 121 | .B·Raises |
122 | \fI\%josepy.errors.UnrecognizedTypeError\fP·\-\-·if·type | 122 | \fBjosepy.errors.UnrecognizedTypeError\fP·\-\-·if·type |
123 | of·the·ACME·object·has·not·been·registered. | 123 | of·the·ACME·object·has·not·been·registered. |
124 | .UNINDENT | 124 | .UNINDENT |
125 | .UNINDENT | 125 | .UNINDENT |
126 | .UNINDENT | 126 | .UNINDENT |
127 | .INDENT·0.0 | 127 | .INDENT·0.0 |
128 | .TP | 128 | .TP |
129 | .B·class·acme.challenges.KeyAuthorizationChallengeResponse(**kwargs:·\fI\%Any\fP) | 129 | .B·class·acme.challenges.KeyAuthorizationChallengeResponse(**kwargs:·Any) |
130 | Response·to·Challenges·based·on·Key·Authorization. | 130 | Response·to·Challenges·based·on·Key·Authorization. |
131 | .INDENT·7.0 | 131 | .INDENT·7.0 |
132 | .TP | 132 | .TP |
133 | .B·Parameters | 133 | .B·Parameters |
134 | \fBkey_authorization\fP·(\fI\%str\fP)·\-\-· | 134 | \fBkey_authorization\fP·(\fIstr\fP)·\-\-· |
135 | .UNINDENT | 135 | .UNINDENT |
136 | .INDENT·7.0 | 136 | .INDENT·7.0 |
137 | .TP | 137 | .TP |
138 | .B·verify(chall:·\fI\%KeyAuthorizationChallenge\fP,·account_public_key:·\fI\%JWK\fP)·->·\fI\%bool\fP | 138 | .B·verify(chall:·\fI\%KeyAuthorizationChallenge\fP,·account_public_key:·JWK)·->·bool |
139 | Verify·the·key·authorization. | 139 | Verify·the·key·authorization. |
140 | .INDENT·7.0 | 140 | .INDENT·7.0 |
141 | .TP | 141 | .TP |
142 | .B·Parameters | 142 | .B·Parameters |
143 | .INDENT·7.0 | 143 | .INDENT·7.0 |
144 | .IP·\(bu·2 | 144 | .IP·\(bu·2 |
145 | \fBchall\fP·(\fIKeyAuthorization\fP)·\-\-·Challenge·that·corresponds·to | 145 | \fBchall\fP·(\fIKeyAuthorization\fP)·\-\-·Challenge·that·corresponds·to |
Offset 149, 68 lines modified | Offset 149, 68 lines modified |
149 | .UNINDENT | 149 | .UNINDENT |
150 | .TP | 150 | .TP |
151 | .B·Returns | 151 | .B·Returns |
152 | \fBTrue\fP·iff·verification·of·the·key·authorization·was | 152 | \fBTrue\fP·iff·verification·of·the·key·authorization·was |
153 | successful. | 153 | successful. |
154 | .TP | 154 | .TP |
155 | .B·Return·type | 155 | .B·Return·type |
156 | \fI\%bool\fP | 156 | bool |
157 | .UNINDENT | 157 | .UNINDENT |
158 | .UNINDENT | 158 | .UNINDENT |
159 | .INDENT·7.0 | 159 | .INDENT·7.0 |
160 | .TP | 160 | .TP |
161 | .B·to_partial_json()·->·\fI\%Dict\fP[\fI\%str\fP,·\fI\%Any\fP] | 161 | .B·to_partial_json()·->·Dict[str,·Any] |
162 | Get·JSON·serializable·object. | 162 | Get·JSON·serializable·object. |
Max diff block lines reached; 55210/60553 bytes (91.18%) of diff not shown.
|