Skip to content

Commit 3825292

Browse files
committed
Add @since tags to AuthenticatorStatus javadoc
1 parent 260aff2 commit 3825292

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

NEWS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ New features:
1414

1515
Fixes:
1616

17-
* Added `@since` tags to `FidoMetadataService` javadoc.
17+
* Added `@since` tags to `AuthenticatorStatus` and `FidoMetadataService` javadoc.
1818

1919

2020
== Version 2.8.1 ==

webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/AuthenticatorStatus.java

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,24 @@
77
* or attestationCertificateKeyIdentifiers and potentially some additional information (such as a
88
* specific attestation key).
99
*
10+
* @since 2.0.0
1011
* @see <a
1112
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
1213
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
1314
*/
1415
public enum AuthenticatorStatus {
15-
/** (NOT DEFINED IN SPEC) Placeholder for any unknown {@link AuthenticatorStatus} value. */
16+
/**
17+
* (NOT DEFINED IN SPEC) Placeholder for any unknown {@link AuthenticatorStatus} value.
18+
*
19+
* @since 2.0.0
20+
*/
1621
@JsonEnumDefaultValue
1722
UNKNOWN(0),
1823

1924
/**
2025
* This authenticator is not FIDO certified.
2126
*
27+
* @since 2.0.0
2228
* @see <a
2329
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
2430
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -29,6 +35,7 @@ public enum AuthenticatorStatus {
2935
* This authenticator has passed FIDO functional certification. This certification scheme is
3036
* phased out and will be replaced by {@link #FIDO_CERTIFIED_L1}.
3137
*
38+
* @since 2.0.0
3239
* @see <a
3340
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
3441
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -40,6 +47,7 @@ public enum AuthenticatorStatus {
4047
* authenticator could be used without the user’s consent and potentially even without the user’s
4148
* knowledge.
4249
*
50+
* @since 2.0.0
4351
* @see <a
4452
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
4553
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -53,6 +61,7 @@ public enum AuthenticatorStatus {
5361
* new registrations of the compromised authenticator. The Authenticator manufacturer should set
5462
* the date to the date when compromise has occurred.
5563
*
64+
* @since 2.0.0
5665
* @see <a
5766
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
5867
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -65,6 +74,7 @@ public enum AuthenticatorStatus {
6574
* to be generated or side channels that allow keys or signatures to be forged, guessed or
6675
* extracted.
6776
*
77+
* @since 2.0.0
6878
* @see <a
6979
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
7080
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -75,6 +85,7 @@ public enum AuthenticatorStatus {
7585
* This authenticator has known weaknesses in its key protection mechanism(s) that allow user keys
7686
* to be extracted by an adversary in physical possession of the device.
7787
*
88+
* @since 2.0.0
7889
* @see <a
7990
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
8091
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -93,6 +104,7 @@ public enum AuthenticatorStatus {
93104
* #USER_KEY_PHYSICAL_COMPROMISE}, {@link #REVOKED}. The Relying party MUST reject the Metadata
94105
* Statement if the authenticatorVersion has not increased
95106
*
107+
* @since 2.0.0
96108
* @see <a
97109
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
98110
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -117,6 +129,7 @@ public enum AuthenticatorStatus {
117129
* For example if it is known to be a fraudulent product or contain a deliberate backdoor. Relying
118130
* parties SHOULD reject any future registration of this authenticator model.
119131
*
132+
* @since 2.0.0
120133
* @see <a
121134
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
122135
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -128,6 +141,7 @@ public enum AuthenticatorStatus {
128141
* FIDO Alliance. If this completed checklist is publicly available, the URL will be specified in
129142
* url.
130143
*
144+
* @since 2.0.0
131145
* @see <a
132146
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
133147
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -138,6 +152,7 @@ public enum AuthenticatorStatus {
138152
* The authenticator has passed FIDO Authenticator certification at level 1. This level is the
139153
* more strict successor of {@link #FIDO_CERTIFIED}.
140154
*
155+
* @since 2.0.0
141156
* @see <a
142157
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
143158
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -148,6 +163,7 @@ public enum AuthenticatorStatus {
148163
* The authenticator has passed FIDO Authenticator certification at level 1+. This level is the
149164
* more than level 1.
150165
*
166+
* @since 2.0.0
151167
* @see <a
152168
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
153169
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -158,6 +174,7 @@ public enum AuthenticatorStatus {
158174
* The authenticator has passed FIDO Authenticator certification at level 2. This level is more
159175
* strict than level 1+.
160176
*
177+
* @since 2.0.0
161178
* @see <a
162179
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
163180
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -168,6 +185,7 @@ public enum AuthenticatorStatus {
168185
* The authenticator has passed FIDO Authenticator certification at level 2+. This level is more
169186
* strict than level 2.
170187
*
188+
* @since 2.0.0
171189
* @see <a
172190
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
173191
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -178,6 +196,7 @@ public enum AuthenticatorStatus {
178196
* The authenticator has passed FIDO Authenticator certification at level 3. This level is more
179197
* strict than level 2+.
180198
*
199+
* @since 2.0.0
181200
* @see <a
182201
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
183202
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>
@@ -188,6 +207,7 @@ public enum AuthenticatorStatus {
188207
* The authenticator has passed FIDO Authenticator certification at level 3+. This level is more
189208
* strict than level 3.
190209
*
210+
* @since 2.0.0
191211
* @see <a
192212
* href="https://fidoalliance.org/specs/mds/fido-metadata-service-v3.0-ps-20210518.html#enumdef-authenticatorstatus">FIDO
193213
* Metadata Service §3.1.4. AuthenticatorStatus enum</a>

0 commit comments

Comments
 (0)