001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.oscal.lib.metapath.function.library; 028 029import gov.nist.secauto.metaschema.model.common.metapath.DynamicContext; 030import gov.nist.secauto.metaschema.model.common.metapath.ISequence; 031import gov.nist.secauto.metaschema.model.common.metapath.MetapathException; 032import gov.nist.secauto.metaschema.model.common.metapath.function.FunctionUtils; 033import gov.nist.secauto.metaschema.model.common.metapath.function.IArgument; 034import gov.nist.secauto.metaschema.model.common.metapath.function.IFunction; 035import gov.nist.secauto.metaschema.model.common.metapath.function.InvalidTypeFunctionException; 036import gov.nist.secauto.metaschema.model.common.metapath.item.IBooleanItem; 037import gov.nist.secauto.metaschema.model.common.metapath.item.IDefinitionNodeItem; 038import gov.nist.secauto.metaschema.model.common.metapath.item.IItem; 039import gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem; 040import gov.nist.secauto.metaschema.model.common.metapath.item.IStringItem; 041import gov.nist.secauto.metaschema.model.common.util.ObjectUtils; 042import gov.nist.secauto.oscal.lib.model.AssessmentPart; 043import gov.nist.secauto.oscal.lib.model.ControlPart; 044import gov.nist.secauto.oscal.lib.model.Property; 045import gov.nist.secauto.oscal.lib.model.metadata.AbstractProperty; 046 047import java.net.URI; 048import java.util.List; 049 050import edu.umd.cs.findbugs.annotations.NonNull; 051 052public final class HasOscalNamespace { 053 @NonNull 054 static final IFunction SIGNATURE_ONE_ARG = IFunction.builder() 055 .name("has-oscal-namespace") 056 .argument(IArgument.newBuilder() 057 .name("namespace") 058 .type(IStringItem.class) 059 .oneOrMore() 060 .build()) 061 .allowUnboundedArity(true) 062 .returnType(IBooleanItem.class) 063 .focusDependent() 064 .contextIndependent() 065 .deterministic() 066 .returnOne() 067 .functionHandler(HasOscalNamespace::executeOneArg) 068 .build(); 069 070 @NonNull 071 static final IFunction SIGNATURE_TWO_ARGS = IFunction.builder() 072 .name("has-oscal-namespace") 073 .argument(IArgument.newBuilder() 074 .name("propOrPart") 075 .type(IDefinitionNodeItem.class) 076 .one() 077 .build()) 078 .argument(IArgument.newBuilder() 079 .name("namespace") 080 .type(IStringItem.class) 081 .oneOrMore() 082 .build()) 083 .allowUnboundedArity(true) 084 .focusIndependent() 085 .contextIndependent() 086 .deterministic() 087 .returnType(IBooleanItem.class) 088 .returnOne() 089 .functionHandler(HasOscalNamespace::executeTwoArg) 090 .build(); 091 092 private HasOscalNamespace() { 093 // disable construction 094 } 095 096 @SuppressWarnings({ "unused", 097 "PMD.OnlyOneReturn" // readability 098 }) 099 @NonNull 100 public static ISequence<?> executeOneArg( 101 @NonNull IFunction function, 102 @NonNull List<ISequence<?>> arguments, 103 @NonNull DynamicContext dynamicContext, 104 INodeItem focus) { 105 INodeItem node = focus; 106 if (node == null) { 107 return ISequence.empty(); 108 } 109 110 assert arguments.size() == 1; 111 ISequence<? extends IStringItem> namespaceArgs = FunctionUtils.asType( 112 ObjectUtils.notNull(arguments.get(0))); 113 if (namespaceArgs.isEmpty()) { 114 return ISequence.empty(); 115 } 116 117 return ISequence.of(hasNamespace(FunctionUtils.asType(node), namespaceArgs)); 118 } 119 120 @SuppressWarnings({ "unused", 121 "PMD.OnlyOneReturn" // readability 122 }) 123 @NonNull 124 public static ISequence<?> executeTwoArg( 125 @NonNull IFunction function, 126 @NonNull List<ISequence<?>> arguments, 127 @NonNull DynamicContext dynamicContext, 128 INodeItem focus) { 129 ISequence<? extends IDefinitionNodeItem> nodeSequence = FunctionUtils.asType( 130 ObjectUtils.notNull(arguments.get(0))); 131 132 IItem node = FunctionUtils.getFirstItem(nodeSequence, true); 133 if (node == null) { 134 return ISequence.empty(); 135 } 136 137 assert arguments.size() == 2; 138 ISequence<? extends IStringItem> namespaceArgs = FunctionUtils.asType( 139 ObjectUtils.notNull(arguments.get(1))); 140 if (namespaceArgs.isEmpty()) { 141 return ISequence.empty(); 142 } 143 144 return ISequence.of(hasNamespace(FunctionUtils.asType(node), namespaceArgs)); 145 } 146 147 @SuppressWarnings("PMD.LinguisticNaming") // false positive 148 @NonNull 149 public static IBooleanItem hasNamespace( 150 @NonNull IDefinitionNodeItem propOrPart, 151 @NonNull ISequence<? extends IStringItem> namespaces) 152 throws MetapathException { 153 Object propOrPartObject = propOrPart.getValue(); 154 if (propOrPartObject == null) { 155 throw new InvalidTypeFunctionException(InvalidTypeFunctionException.NODE_HAS_NO_TYPED_VALUE, propOrPart); 156 } 157 158 URI nodeNamespace; 159 if (propOrPartObject instanceof Property) { 160 nodeNamespace = ((Property) propOrPartObject).getNs(); 161 } else if (propOrPartObject instanceof ControlPart) { 162 nodeNamespace = ((ControlPart) propOrPartObject).getNs(); 163 } else if (propOrPartObject instanceof AssessmentPart) { 164 nodeNamespace = ((AssessmentPart) propOrPartObject).getNs(); 165 } else { 166 throw new MetapathException( 167 String.format("Node of definition type '%s' has no OSCAL namespace", propOrPart.getDefinition().getName())); 168 } 169 170 String nodeNamespaceString = AbstractProperty.normalizeNamespace(nodeNamespace).toString(); 171 return IBooleanItem.valueOf(namespaces.asStream() 172 .map(node -> nodeNamespaceString.equals(node.asString())) 173 .anyMatch(bool -> bool)); 174 } 175}