io.apicurio.datamodels.validation.rules.invalid.value.OasSecurityRequirementScopesMustBeEmptyRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apicurio-data-models Show documentation
Open Source API Design Studio
The newest version!
/*
 * Copyright 2019 Red Hat
 *
 * 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 io.apicurio.datamodels.validation.rules.invalid.value;

import java.util.ArrayList;
import java.util.List;

import io.apicurio.datamodels.models.ModelType;
import io.apicurio.datamodels.models.SecurityRequirement;
import io.apicurio.datamodels.models.SecurityScheme;
import io.apicurio.datamodels.models.openapi.OpenApiDocument;
import io.apicurio.datamodels.models.openapi.v20.OpenApi20Document;
import io.apicurio.datamodels.models.openapi.v30.OpenApi30Document;
import io.apicurio.datamodels.validation.ValidationRuleMetaData;

/**
 * Implements the Security Requirement Scopes Must Be Empty rule.
 * @author [email protected]
 */
public class OasSecurityRequirementScopesMustBeEmptyRule extends AbstractInvalidPropertyValueRule {

    /**
     * Constructor.
     * @param ruleInfo
     */
    public OasSecurityRequirementScopesMustBeEmptyRule(ValidationRuleMetaData ruleInfo) {
        super(ruleInfo);
    }

    private SecurityScheme findSecurityScheme(OpenApiDocument document, String schemeName) {
        if (document.root().modelType() == ModelType.OPENAPI20) {
            OpenApi20Document doc20 = (OpenApi20Document) document;
            if (hasValue(doc20.getSecurityDefinitions())) {
                return doc20.getSecurityDefinitions().getItem(schemeName);
            }
        } else {
            OpenApi30Document doc30 = (OpenApi30Document) document;
            if (hasValue(doc30.getComponents()) && hasValue(doc30.getComponents().getSecuritySchemes())) {
                return doc30.getComponents().getSecuritySchemes().get(schemeName);
            }
        }

        return null;
    }

    /**
     * @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityRequirement(io.apicurio.datamodels.core.models.common.SecurityRequirement)
     */
    @Override
    public void visitSecurityRequirement(SecurityRequirement node) {
        List allowedTypes = new ArrayList<>();
        allowedTypes.add("oauth2");
        String options = "\"oauth2\"";
        if (node.root().modelType() == ModelType.OPENAPI30) {
            allowedTypes.add("openIdConnect");
            options = "\"oauth2\" or \"openIdConnect\"";
        }
        List snames = node.getItemNames();
        for (String sname : snames) {
            SecurityScheme scheme = findSecurityScheme((OpenApiDocument) node.root(), sname);
            if (hasValue(scheme)) {
                if (allowedTypes.indexOf(scheme.getType()) == -1) {
                    List scopes = getScopes(node, sname);
                    this.reportIfInvalid(hasValue(scopes) && scopes.size() == 0, node, null, map("sname", sname, "options", options));
                }
            }
        };
    }

    private List getScopes(SecurityRequirement node, String sname) {
        return node.getItem(sname);
    }

}