github.com/google/go-safeweb@v0.0.0-20231219055052-64d8cfc90fbb/safesql/uncheckedconversions/uncheckedconversions.go (about)

     1  // Copyright 2020 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 uncheckedconversions provides functions to create values of package safesql types from plain strings.
    16  // Uses of these functions could potentially result in instances of safesql types that violate their type contracts, and hence result in security vulnerabilities.
    17  package uncheckedconversions
    18  
    19  import (
    20  	"github.com/google/go-safeweb/safesql"
    21  	"github.com/google/go-safeweb/safesql/internal/raw"
    22  )
    23  
    24  var trustedSQLStringCtor = raw.TrustedSQLString.(func(string) safesql.TrustedSQLString)
    25  
    26  // TrustedSQLStringFromStringKnownToSatisfyTypeContract promotes the given string to a trusted string.
    27  // Only strings known to be under the programmer control and trusted strings should be passed to this function.
    28  //
    29  // One example of correct use of this function would be to cast a query that was retrieved from a query storage to be used with the safesql package.
    30  // If the query storage is under the programmer control and user input cannot be put into it then the string is known to satisfy the type contract.
    31  func TrustedSQLStringFromStringKnownToSatisfyTypeContract(trusted string) safesql.TrustedSQLString {
    32  	return trustedSQLStringCtor(trusted)
    33  }