Skip to content

Enforce system-app authorization on OAuth provider endpoints #16112

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.

Sign up for GitHub

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

Open
TristanInSec wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Enforce system-app authorization on OAuth provider endpoints #16112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions ...cdap-data-pipeline-base/src/main/java/io/cdap/cdap/datapipeline/service/OAuthHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
import io.cdap.cdap.datapipeline.oauth.PutOAuthCredentialRequest;
import io.cdap.cdap.datapipeline.oauth.PutOAuthProviderRequest;
import io.cdap.cdap.datapipeline.oauth.RefreshTokenResponse;
import io.cdap.cdap.proto.element.EntityType;
import io.cdap.cdap.proto.id.NamespaceId;
import io.cdap.cdap.proto.security.StandardPermission;
import io.cdap.cdap.security.spi.authorization.ContextAccessEnforcer;
import io.cdap.common.http.HttpRequest;
import io.cdap.common.http.HttpRequests;
import io.cdap.common.http.HttpResponse;
Expand Down Expand Up @@ -71,11 +75,25 @@ public class OAuthHandler extends AbstractSystemHttpServiceHandler {
.create();

private OAuthStore oauthStore;
private ContextAccessEnforcer contextAccessEnforcer;

@Override
public void initialize(SystemHttpServiceContext context) throws Exception {
super.initialize(context);
this.oauthStore = new OAuthStore(context, context, context.getAdmin());
this.contextAccessEnforcer = context.getContextAccessEnforcer();
}

/**
* OAuth providers and credentials are a cluster-wide resource managed by the
* data pipeline system app. Gate every endpoint on the caller having the
* matching permission on the system-app parent in the system namespace, so
* only users authorized to administer system apps can list, read, create,
* update or delete OAuth providers and credentials.
*/
private void enforceSystemAppPermission(StandardPermission permission) {
contextAccessEnforcer.enforceOnParent(
EntityType.SYSTEM_APP_ENTITY, NamespaceId.SYSTEM, permission);
}

@GET
Expand All @@ -85,6 +103,7 @@ public void getAuthURL(HttpServiceRequest request, HttpServiceResponder responde
@QueryParam("redirect_uri") String redirectURI,
@QueryParam("redirect_url") String redirectURL) {
try {
enforceSystemAppPermission(StandardPermission.GET);
OAuthProvider oauthProvider = getProvider(provider);

String formatURL = "%s";
Expand Down Expand Up @@ -116,6 +135,7 @@ public void putOAuthProvider(HttpServiceRequest request, HttpServiceResponder re
@QueryParam("reuse_client_credentials") @DefaultValue("false")
Boolean reuseClientCredentials) {
try {
enforceSystemAppPermission(StandardPermission.UPDATE);
try {
PutOAuthProviderRequest putOAuthProviderRequest = GSON.fromJson(
StandardCharsets.UTF_8.decode(request.getContent()).toString(),
Expand Down Expand Up @@ -163,6 +183,7 @@ public void putOAuthProvider(HttpServiceRequest request, HttpServiceResponder re
public void deleteOAuthProvider(HttpServiceRequest request, HttpServiceResponder responder,
@PathParam("provider") String oauthProvider) {
try {
enforceSystemAppPermission(StandardPermission.DELETE);
try {
oauthStore.deleteProvider(oauthProvider);
responder.sendStatus(HttpURLConnection.HTTP_OK);
Expand All @@ -182,6 +203,7 @@ public void putOAuthCredential(HttpServiceRequest request, HttpServiceResponder
@PathParam("provider") String provider,
@PathParam("credential") String credentialId) {
try {
enforceSystemAppPermission(StandardPermission.UPDATE);
PutOAuthCredentialRequest putOAuthCredentialRequest;
try {
putOAuthCredentialRequest = GSON.fromJson(StandardCharsets.UTF_8.decode(request.getContent()).toString(),
Expand Down Expand Up @@ -291,6 +313,7 @@ public void getOAuthCredential(HttpServiceRequest request, HttpServiceResponder
@PathParam("provider") String provider,
@PathParam("credential") String credentialId) {
try {
enforceSystemAppPermission(StandardPermission.GET);
OAuthProvider oauthProvider = getProvider(provider);
Optional<OAuthAccessToken> oAuthAccessToken = getAccessToken(provider, credentialId);

Expand Down Expand Up @@ -371,6 +394,7 @@ public void getOAuthCredentialValidity(HttpServiceRequest request, HttpServiceRe
@PathParam("provider") String provider,
@PathParam("credential") String credentialId) {
try {
enforceSystemAppPermission(StandardPermission.GET);
OAuthProvider oauthProvider = getProvider(provider);
Optional<OAuthAccessToken> oAuthAccessToken = getAccessToken(provider, credentialId);

Expand Down