github.com/google/go-safeweb@v0.0.0-20231219055052-64d8cfc90fbb/safehttp/plugins/fetchmetadata/internalunsafefetchmetadata/unsaferesourcepolicy/unsaferesourcepolicy.go (about)

     1  // Copyright 2022 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //	https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package unsaferesourcepolicy can be used to disable Fetch Metadata protections on specific handler registration.
    16  //
    17  // This package is visibility restricted and its uses require a review by the security team.
    18  package unsaferesourcepolicy
    19  
    20  import (
    21  	"github.com/google/go-safeweb/safehttp/plugins/fetchmetadata/internalunsafefetchmetadata"
    22  )
    23  
    24  // Disable switches the resource isolation policy to report-only.
    25  // If skipReports is true, it will completely disable it.
    26  func Disable(reason string, skipReports bool) internalunsafefetchmetadata.DisableResourceIsolationPolicy {
    27  	if reason == "" {
    28  		panic("reason cannot be empty")
    29  	}
    30  	return internalunsafefetchmetadata.DisableResourceIsolationPolicy{SkipReports: skipReports}
    31  }