Skip to content

Add mutualTLS to SecuritySchemeType #613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
package org.eclipse.microprofile.openapi.annotations.enums;

public enum SecuritySchemeType {
DEFAULT(""), APIKEY("apiKey"), HTTP("http"), OPENIDCONNECT("openIdConnect"), OAUTH2("oauth2");
DEFAULT(""), APIKEY("apiKey"), HTTP("http"), OPENIDCONNECT("openIdConnect"), OAUTH2("oauth2"), MUTUALTLS(
"mutualTLS");

private String value;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@
* </ul>
*/

@org.osgi.annotation.versioning.Version("1.0")
@org.osgi.annotation.versioning.Version("1.1")
@org.osgi.annotation.versioning.ProviderType
package org.eclipse.microprofile.openapi.annotations.enums;
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public interface SecurityScheme extends Constructible, Extensible<SecurityScheme
* </p>
*/
public enum Type {
APIKEY("apiKey"), HTTP("http"), OAUTH2("oauth2"), OPENIDCONNECT("openIdConnect");
APIKEY("apiKey"), HTTP("http"), OAUTH2("oauth2"), OPENIDCONNECT("openIdConnect"), MUTUALTLS("mutualTLS");

private final String value;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@
* </pre>
*/

@org.osgi.annotation.versioning.Version("2.0")
@org.osgi.annotation.versioning.Version("2.1")
@org.osgi.annotation.versioning.ProviderType
package org.eclipse.microprofile.openapi.models.security;
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/**
* Copyright (c) 2024 Contributors to the Eclipse Foundation
* <p>
* 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.
*/

package org.eclipse.microprofile.openapi.apps.airlines.resources;

import org.eclipse.microprofile.openapi.annotations.Operation;
import org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType;
import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
import org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement;
import org.eclipse.microprofile.openapi.annotations.security.SecurityScheme;

import jakarta.ws.rs.DELETE;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.Response;

@Path("/zepplins")
@SecurityScheme(securitySchemeName = "mutualTLSScheme", type = SecuritySchemeType.MUTUALTLS,
description = "mutualTLS authentication needed to manage zepplins")
public class ZepplinResource {

@DELETE
@Path("{id}")
@APIResponse(responseCode = "200", description = "Review deleted")
@APIResponse(responseCode = "404", description = "Review not found")
@Operation(summary = "Deprecate outdated airship technology", operationId = "deprecateZepplin")
@Produces("text/plain")
@SecurityRequirement(name = "mutualTLSScheme")
public Response deprecateZepplin() {
return Response.ok().build();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,10 @@ public void testSecurityScheme(String type) {
String reviewoauth2 = "components.securitySchemes.reviewoauth2.";
vr.body(reviewoauth2 + "type", equalTo("oauth2"));
vr.body(reviewoauth2 + "description", equalTo("authentication needed to create and delete reviews"));

String mutualTLS = "components.securitySchemes.mutualTLSScheme.";
vr.body(mutualTLS + "type", equalTo("mutualTLS"));
vr.body(mutualTLS + "description", equalTo("mutualTLS authentication needed to manage zepplins"));
}

@Test(dataProvider = "formatProvider")
Expand Down
Loading