Skip to content

Latest commit

 

History

History
1822 lines (1261 loc) · 63 KB

Microsoft.NetCore.Analyzers.md

File metadata and controls

1822 lines (1261 loc) · 63 KB

Microsoft.NetCore.Analyzers

CA1303: Do not pass literals as localized parameters

Item Value
Category Globalization
Enabled True
Severity Warning
CodeFix False

Rule description

A method passes a string literal as a parameter to a constructor or method in the .NET Framework class library and that string should be localizable. To fix a violation of this rule, replace the string literal with a string retrieved through an instance of the ResourceManager class.

CA1304: Specify CultureInfo

Item Value
Category Globalization
Enabled True
Severity Warning
CodeFix False

Rule description

A method or constructor calls a member that has an overload that accepts a System.Globalization.CultureInfo parameter, and the method or constructor does not call the overload that takes the CultureInfo parameter. When a CultureInfo or System.IFormatProvider object is not supplied, the default value that is supplied by the overloaded member might not have the effect that you want in all locales. If the result will be displayed to the user, specify 'CultureInfo.CurrentCulture' as the 'CultureInfo' parameter. Otherwise, if the result will be stored and accessed by software, such as when it is persisted to disk or to a database, specify 'CultureInfo.InvariantCulture'.

CA1305: Specify IFormatProvider

Item Value
Category Globalization
Enabled True
Severity Warning
CodeFix False

Rule description

A method or constructor calls one or more members that have overloads that accept a System.IFormatProvider parameter, and the method or constructor does not call the overload that takes the IFormatProvider parameter. When a System.Globalization.CultureInfo or IFormatProvider object is not supplied, the default value that is supplied by the overloaded member might not have the effect that you want in all locales. If the result will be based on the input from/output displayed to the user, specify 'CultureInfo.CurrentCulture' as the 'IFormatProvider'. Otherwise, if the result will be stored and accessed by software, such as when it is loaded from disk/database and when it is persisted to disk/database, specify 'CultureInfo.InvariantCulture'.

CA1307: Specify StringComparison

Item Value
Category Globalization
Enabled True
Severity Warning
CodeFix False

Rule description

A string comparison operation uses a method overload that does not set a StringComparison parameter. If the result will be displayed to the user, such as when sorting a list of items for display in a list box, specify 'StringComparison.CurrentCulture' or 'StringComparison.CurrentCultureIgnoreCase' as the 'StringComparison' parameter. If comparing case-insensitive identifiers, such as file paths, environment variables, or registry keys and values, specify 'StringComparison.OrdinalIgnoreCase'. Otherwise, if comparing case-sensitive identifiers, specify 'StringComparison.Ordinal'.

CA1308: Normalize strings to uppercase

Item Value
Category Globalization
Enabled True
Severity Warning
CodeFix False

Rule description

Strings should be normalized to uppercase. A small group of characters cannot make a round trip when they are converted to lowercase. To make a round trip means to convert the characters from one locale to another locale that represents character data differently, and then to accurately retrieve the original characters from the converted characters.

CA1309: Use ordinal stringcomparison

Item Value
Category Globalization
Enabled False
Severity Warning
CodeFix True

Rule description

A string comparison operation that is nonlinguistic does not set the StringComparison parameter to either Ordinal or OrdinalIgnoreCase. By explicitly setting the parameter to either StringComparison.Ordinal or StringComparison.OrdinalIgnoreCase, your code often gains speed, becomes more correct, and becomes more reliable.

CA1401: P/Invokes should not be visible

Item Value
Category Interoperability
Enabled True
Severity Warning
CodeFix False

Rule description

A public or protected method in a public type has the System.Runtime.InteropServices.DllImportAttribute attribute (also implemented by the Declare keyword in Visual Basic). Such methods should not be exposed.

CA1417: Do not use 'OutAttribute' on string parameters for P/Invokes

Item Value
Category Interoperability
Enabled True
Severity Warning
CodeFix False

Rule description

String parameters passed by value with the 'OutAttribute' can destabilize the runtime if the string is an interned string.

CA1810: Initialize reference type static fields inline

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix False

Rule description

A reference type declares an explicit static constructor. To fix a violation of this rule, initialize all static data when it is declared and remove the static constructor.

CA1813: Avoid unsealed attributes

Item Value
Category Performance
Enabled False
Severity Warning
CodeFix True

Rule description

The .NET Framework class library provides methods for retrieving custom attributes. By default, these methods search the attribute inheritance hierarchy. Sealing the attribute eliminates the search through the inheritance hierarchy and can improve performance.

CA1816: Dispose methods should call SuppressFinalize

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix False

Rule description

A method that is an implementation of Dispose does not call GC.SuppressFinalize; or a method that is not an implementation of Dispose calls GC.SuppressFinalize; or a method calls GC.SuppressFinalize and passes something other than this (Me in Visual?Basic).

CA1820: Test for empty strings using string length

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

Comparing strings by using the String.Length property or the String.IsNullOrEmpty method is significantly faster than using Equals.

CA1824: Mark assemblies with NeutralResourcesLanguageAttribute

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix False

Rule description

The NeutralResourcesLanguage attribute informs the ResourceManager of the language that was used to display the resources of a neutral culture for an assembly. This improves lookup performance for the first resource that you load and can reduce your working set.

CA1825: Avoid zero-length array allocations

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

Avoid unnecessary zero-length array allocations. Use {0} instead.

CA1826: Do not use Enumerable methods on indexable collections

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

This collection is directly indexable. Going through LINQ here causes unnecessary allocations and CPU work.

CA1827: Do not use Count() or LongCount() when Any() can be used

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

For non-empty collections, Count() and LongCount() enumerate the entire sequence, while Any() stops at the first item or the first item that satisfies a condition.

CA1828: Do not use CountAsync() or LongCountAsync() when AnyAsync() can be used

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

For non-empty collections, CountAsync() and LongCountAsync() enumerate the entire sequence, while AnyAsync() stops at the first item or the first item that satisfies a condition.

CA1829: Use Length/Count property instead of Count() when available

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

Enumerable.Count() potentially enumerates the sequence while a Length/Count property is a direct access.

CA1830: Prefer strongly-typed Append and Insert method overloads on StringBuilder

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

StringBuilder.Append and StringBuilder.Insert provide overloads for multiple types beyond System.String. When possible, prefer the strongly-typed overloads over using ToString() and the string-based overload.

CA1831: Use AsSpan or AsMemory instead of Range-based indexers when appropriate

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

The Range-based indexer on string values produces a copy of requested portion of the string. This copy is usually unnecessary when it is implicitly used as a ReadOnlySpan or ReadOnlyMemory value. Use the AsSpan method to avoid the unnecessary copy.

CA1832: Use AsSpan or AsMemory instead of Range-based indexers when appropriate

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

The Range-based indexer on array values produces a copy of requested portion of the array. This copy is usually unnecessary when it is implicitly used as a ReadOnlySpan or ReadOnlyMemory value. Use the AsSpan method to avoid the unnecessary copy.

CA1833: Use AsSpan or AsMemory instead of Range-based indexers when appropriate

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

The Range-based indexer on array values produces a copy of requested portion of the array. This copy is often unwanted when it is implicitly used as a Span or Memory value. Use the AsSpan method to avoid the copy.

CA1834: Consider using 'StringBuilder.Append(char)' when applicable

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

'StringBuilder.Append(char)' is more efficient than 'StringBuilder.Append(string)' when the string is a single character. When calling 'Append' with a constant, prefer using a constant char rather than a constant string containing one character.

CA1835: Prefer the 'Memory'-based overloads for 'ReadAsync' and 'WriteAsync'

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

'Stream' has a 'ReadAsync' overload that takes a 'Memory' as the first argument, and a 'WriteAsync' overload that takes a 'ReadOnlyMemory' as the first argument. Prefer calling the memory based overloads, which are more efficient.

CA1836: Prefer IsEmpty over Count

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

For determining whether the object contains or not any items, prefer using 'IsEmpty' property rather than retrieving the number of items from the 'Count' property and comparing it to 0 or 1.

CA1837: Use 'Environment.ProcessId'

Item Value
Category Performance
Enabled True
Severity Warning
CodeFix True

Rule description

'Environment.ProcessId' is simpler and faster than 'Process.GetCurrentProcess().Id'.

CA1838: Avoid 'StringBuilder' parameters for P/Invokes

Item Value
Category Performance
Enabled False
Severity Warning
CodeFix False

Rule description

Marshalling of 'StringBuilder' always creates a native buffer copy, resulting in multiple allocations for one marshalling operation.

CA2000: Dispose objects before losing scope

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix False

Rule description

If a disposable object is not explicitly disposed before all references to it are out of scope, the object will be disposed at some indeterminate time when the garbage collector runs the finalizer of the object. Because an exceptional event might occur that will prevent the finalizer of the object from running, the object should be explicitly disposed instead.

CA2002: Do not lock on objects with weak identity

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix False

Rule description

An object is said to have a weak identity when it can be directly accessed across application domain boundaries. A thread that tries to acquire a lock on an object that has a weak identity can be blocked by a second thread in a different application domain that has a lock on the same object.

CA2008: Do not create tasks without passing a TaskScheduler

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix False

Rule description

Do not create tasks unless you are using one of the overloads that takes a TaskScheduler. The default is to schedule on TaskScheduler.Current, which would lead to deadlocks. Either use TaskScheduler.Default to schedule on the thread pool, or explicitly pass TaskScheduler.Current to make your intentions clear.

CA2009: Do not call ToImmutableCollection on an ImmutableCollection value

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix True

Rule description

Do not call {0} on an {1} value

CA2012: Use ValueTasks correctly

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix False

Rule description

ValueTasks returned from member invocations are intended to be directly awaited. Attempts to consume a ValueTask multiple times or to directly access one's result before it's known to be completed may result in an exception or corruption. Ignoring such a ValueTask is likely an indication of a functional bug and may degrade performance.

CA2013: Do not use ReferenceEquals with value types

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix False

Rule description

Value type typed arguments are uniquely boxed for each call to this method, therefore the result is always false.

CA2014: Do not use stackalloc in loops

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix False

Rule description

Stack space allocated by a stackalloc is only released at the end of the current method's invocation. Using it in a loop can result in unbounded stack growth and eventual stack overflow conditions.

CA2015: Do not define finalizers for types derived from MemoryManager

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix False

Rule description

Adding a finalizer to a type derived from MemoryManager may permit memory to be freed while it is still in use by a Span.

CA2016: Forward the 'CancellationToken' parameter to methods that take one

Item Value
Category Reliability
Enabled True
Severity Warning
CodeFix True

Rule description

Forward the 'CancellationToken' parameter to methods that take one to ensure the operation cancellation notifications gets properly propagated, or pass in 'CancellationToken.None' explicitly to indicate intentionally not propagating the token.

CA2100: Review SQL queries for security vulnerabilities

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

SQL queries that directly use user input can be vulnerable to SQL injection attacks. Review this SQL query for potential vulnerabilities, and consider using a parameterized SQL query.

CA2101: Specify marshaling for P/Invoke string arguments

Item Value
Category Globalization
Enabled True
Severity Warning
CodeFix True

Rule description

A platform invoke member allows partially trusted callers, has a string parameter, and does not explicitly marshal the string. This can cause a potential security vulnerability.

CA2201: Do not raise reserved exception types

Item Value
Category Usage
Enabled False
Severity Warning
CodeFix False

Rule description

An exception of type that is not sufficiently specific or reserved by the runtime should never be raised by user code. This makes the original error difficult to detect and debug. If this exception instance might be thrown, use a different exception type.

CA2207: Initialize value type static fields inline

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix False

Rule description

A value type declares an explicit static constructor. To fix a violation of this rule, initialize all static data when it is declared and remove the static constructor.

CA2208: Instantiate argument exceptions correctly

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

A call is made to the default (parameterless) constructor of an exception type that is or derives from ArgumentException, or an incorrect string argument is passed to a parameterized constructor of an exception type that is or derives from ArgumentException.

CA2213: Disposable fields should be disposed

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix False

Rule description

A type that implements System.IDisposable declares fields that are of types that also implement IDisposable. The Dispose method of the field is not called by the Dispose method of the declaring type. To fix a violation of this rule, call Dispose on fields that are of types that implement IDisposable if you are responsible for allocating and releasing the unmanaged resources held by the field.

CA2215: Dispose methods should call base class dispose

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

A type that implements System.IDisposable inherits from a type that also implements IDisposable. The Dispose method of the inheriting type does not call the Dispose method of the parent type. To fix a violation of this rule, call base.Dispose in your Dispose method.

CA2216: Disposable types should declare finalizer

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix False

Rule description

A type that implements System.IDisposable and has fields that suggest the use of unmanaged resources does not implement a finalizer, as described by Object.Finalize.

CA2229: Implement serialization constructors

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

To fix a violation of this rule, implement the serialization constructor. For a sealed class, make the constructor private; otherwise, make it protected.

CA2235: Mark all non-serializable fields

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

An instance field of a type that is not serializable is declared in a type that is serializable.

CA2237: Mark ISerializable types with serializable

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

To be recognized by the common language runtime as serializable, types must be marked by using the SerializableAttribute attribute even when the type uses a custom serialization routine through implementation of the ISerializable interface.

CA2241: Provide correct arguments to formatting methods

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix False

Rule description

The format argument that is passed to System.String.Format does not contain a format item that corresponds to each object argument, or vice versa.

CA2242: Test for NaN correctly

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

This expression tests a value against Single.Nan or Double.Nan. Use Single.IsNan(Single) or Double.IsNan(Double) to test the value.

CA2243: Attribute string literals should parse correctly

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix False

Rule description

The string literal parameter of an attribute does not parse correctly for a URL, a GUID, or a version.

CA2247: Argument passed to TaskCompletionSource constructor should be TaskCreationOptions enum instead of TaskContinuationOptions enum

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

TaskCompletionSource has constructors that take TaskCreationOptions that control the underlying Task, and constructors that take object state that's stored in the task. Accidentally passing a TaskContinuationOptions instead of a TaskCreationOptions will result in the call treating the options as state.

CA2248: Provide correct 'enum' argument to 'Enum.HasFlag'

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix False

Rule description

'Enum.HasFlag' method expects the 'enum' argument to be of the same 'enum' type as the instance on which the method is invoked and that this 'enum' is marked with 'System.FlagsAttribute'. If these are different 'enum' types, an unhandled exception will be thrown at runtime. If the 'enum' type is not marked with 'System.FlagsAttribute' the call will always return 'false' at runtime.

CA2249: Consider using 'string.Contains' instead of 'string.IndexOf'

Item Value
Category Usage
Enabled True
Severity Warning
CodeFix True

Rule description

Calls to 'string.IndexOf' where the result is used to check for the presence/absence of a substring can be replaced by 'string.Contains'.

CA2300: Do not use insecure deserializer BinaryFormatter

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data. If you need to instead detect BinaryFormatter deserialization without a SerializationBinder set, then disable rule CA2300, and enable rules CA2301 and CA2302.

CA2301: Do not call BinaryFormatter.Deserialize without first setting BinaryFormatter.Binder

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data without a SerializationBinder to restrict the type of objects in the deserialized object graph.

CA2302: Ensure BinaryFormatter.Binder is set before calling BinaryFormatter.Deserialize

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data without a SerializationBinder to restrict the type of objects in the deserialized object graph.

CA2305: Do not use insecure deserializer LosFormatter

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data.

CA2310: Do not use insecure deserializer NetDataContractSerializer

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data. If you need to instead detect NetDataContractSerializer deserialization without a SerializationBinder set, then disable rule CA2310, and enable rules CA2311 and CA2312.

CA2311: Do not deserialize without first setting NetDataContractSerializer.Binder

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data without a SerializationBinder to restrict the type of objects in the deserialized object graph.

CA2312: Ensure NetDataContractSerializer.Binder is set before deserializing

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data without a SerializationBinder to restrict the type of objects in the deserialized object graph.

CA2315: Do not use insecure deserializer ObjectStateFormatter

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data.

CA2321: Do not deserialize with JavaScriptSerializer using a SimpleTypeResolver

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data with a JavaScriptSerializer initialized with a SimpleTypeResolver. Initialize JavaScriptSerializer without a JavaScriptTypeResolver specified, or initialize with a JavaScriptTypeResolver that limits the types of objects in the deserialized object graph.

CA2322: Ensure JavaScriptSerializer is not initialized with SimpleTypeResolver before deserializing

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data with a JavaScriptSerializer initialized with a SimpleTypeResolver. Ensure that the JavaScriptSerializer is initialized without a JavaScriptTypeResolver specified, or initialized with a JavaScriptTypeResolver that limits the types of objects in the deserialized object graph.

CA2326: Do not use TypeNameHandling values other than None

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Deserializing JSON when using a TypeNameHandling value other than None can be insecure. If you need to instead detect Json.NET deserialization when a SerializationBinder isn't specified, then disable rule CA2326, and enable rules CA2327, CA2328, CA2329, and CA2330.

CA2327: Do not use insecure JsonSerializerSettings

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, allowing arbitrary types to be deserialized is insecure. When using JsonSerializerSettings, use TypeNameHandling.None, or for values other than None, restrict deserialized types with a SerializationBinder.

CA2328: Ensure that JsonSerializerSettings are secure

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, allowing arbitrary types to be deserialized is insecure. When using JsonSerializerSettings, ensure TypeNameHandling.None is specified, or for values other than None, ensure a SerializationBinder is specified to restrict deserialized types.

CA2329: Do not deserialize with JsonSerializer using an insecure configuration

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, allowing arbitrary types to be deserialized is insecure. When using deserializing JsonSerializer, use TypeNameHandling.None, or for values other than None, restrict deserialized types with a SerializationBinder.

CA2330: Ensure that JsonSerializer has a secure configuration when deserializing

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, allowing arbitrary types to be deserialized is insecure. When using deserializing JsonSerializer, use TypeNameHandling.None, or for values other than None, restrict deserialized types with a SerializationBinder.

CA2350: Do not use DataTable.ReadXml() with untrusted data

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data

CA2351: Do not use DataSet.ReadXml() with untrusted data

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data

CA2352: Unsafe DataSet or DataTable in serializable type can be vulnerable to remote code execution attacks

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input with an IFormatter-based serializer, deserializing a {0} object is insecure. '{1}' either is or derives from {0}.

CA2353: Unsafe DataSet or DataTable in serializable type

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, deserializing a {0} object is insecure. '{1}' either is or derives from {0}

CA2354: Unsafe DataSet or DataTable in deserialized object graph can be vulnerable to remote code execution attacks

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, deserializing a {0} object is insecure. '{1}' either is or derives from {0}

CA2355: Unsafe DataSet or DataTable type found in deserializable object graph

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, deserializing a {0} object is insecure. '{1}' either is or derives from {0}

CA2356: Unsafe DataSet or DataTable type in web deserializable object graph

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input, deserializing a {0} object is insecure. '{1}' either is or derives from {0}

CA2361: Ensure autogenerated class containing DataSet.ReadXml() is not used with untrusted data

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

The method '{0}' is insecure when deserializing untrusted data. Make sure that autogenerated class containing the '{0}' call is not deserialized with untrusted data.

CA2362: Unsafe DataSet or DataTable in autogenerated serializable type can be vulnerable to remote code execution attacks

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deserializing untrusted input with an IFormatter-based serializer, deserializing a {0} object is insecure. '{1}' either is or derives from {0}. Ensure that the autogenerated type is never deserialized with untrusted data.

CA3001: Review code for SQL injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential SQL injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3002: Review code for XSS vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential cross-site scripting (XSS) vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3003: Review code for file path injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential file path injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3004: Review code for information disclosure vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential information disclosure vulnerability was found where '{0}' in method '{1}' may contain unintended information from '{2}' in method '{3}'.

CA3005: Review code for LDAP injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential LDAP injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3006: Review code for process command injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential process command injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3007: Review code for open redirect vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential open redirect vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3008: Review code for XPath injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential XPath injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3009: Review code for XML injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential XML injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3010: Review code for XAML injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential XAML injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3011: Review code for DLL injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential DLL injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3012: Review code for regex injection vulnerabilities

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Potential regex injection vulnerability was found where '{0}' in method '{1}' may be tainted by user-controlled data from '{2}' in method '{3}'.

CA3061: Do Not Add Schema By URL

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

This overload of XmlSchemaCollection.Add method internally enables DTD processing on the XML reader instance used, and uses UrlResolver for resolving external XML entities. The outcome is information disclosure. Content from file system or network shares for the machine processing the XML can be exposed to attacker. In addition, an attacker can use this as a DoS vector.

CA5350: Do Not Use Weak Cryptographic Algorithms

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Cryptographic algorithms degrade over time as attacks become for advances to attacker get access to more computation. Depending on the type and application of this cryptographic algorithm, further degradation of the cryptographic strength of it may allow attackers to read enciphered messages, tamper with enciphered  messages, forge digital signatures, tamper with hashed content, or otherwise compromise any cryptosystem based on this algorithm. Replace encryption uses with the AES algorithm (AES-256, AES-192 and AES-128 are acceptable) with a key length greater than or equal to 128 bits. Replace hashing uses with a hashing function in the SHA-2 family, such as SHA-2 512, SHA-2 384, or SHA-2 256.

CA5351: Do Not Use Broken Cryptographic Algorithms

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

An attack making it computationally feasible to break this algorithm exists. This allows attackers to break the cryptographic guarantees it is designed to provide. Depending on the type and application of this cryptographic algorithm, this may allow attackers to read enciphered messages, tamper with enciphered  messages, forge digital signatures, tamper with hashed content, or otherwise compromise any cryptosystem based on this algorithm. Replace encryption uses with the AES algorithm (AES-256, AES-192 and AES-128 are acceptable) with a key length greater than or equal to 128 bits. Replace hashing uses with a hashing function in the SHA-2 family, such as SHA512, SHA384, or SHA256. Replace digital signature uses with RSA with a key length greater than or equal to 2048-bits, or ECDSA with a key length greater than or equal to 256 bits.

CA5358: Review cipher mode usage with cryptography experts

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

These cipher modes might be vulnerable to attacks. Consider using recommended modes (CBC, CTS).

CA5359: Do Not Disable Certificate Validation

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

A certificate can help authenticate the identity of the server. Clients should validate the server certificate to ensure requests are sent to the intended server. If the ServerCertificateValidationCallback always returns 'true', any certificate will pass validation.

CA5360: Do Not Call Dangerous Methods In Deserialization

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Insecure Deserialization is a vulnerability which occurs when untrusted data is used to abuse the logic of an application, inflict a Denial-of-Service (DoS) attack, or even execute arbitrary code upon it being deserialized. It’s frequently possible for malicious users to abuse these deserialization features when the application is deserializing untrusted data which is under their control. Specifically, invoke dangerous methods in the process of deserialization. Successful insecure deserialization attacks could allow an attacker to carry out attacks such as DoS attacks, authentication bypasses, and remote code execution.

CA5361: Do Not Disable SChannel Use of Strong Crypto

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Starting with the .NET Framework 4.6, the System.Net.ServicePointManager and System.Net.Security.SslStream classes are recommeded to use new protocols. The old ones have protocol weaknesses and are not supported. Setting Switch.System.Net.DontEnableSchUseStrongCrypto with true will use the old weak crypto check and opt out of the protocol migration.

CA5362: Potential reference cycle in deserialized object graph

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Review code that processes untrusted deserialized data for handling of unexpected reference cycles. An unexpected reference cycle should not cause the code to enter an infinite loop. Otherwise, an unexpected reference cycle can allow an attacker to DOS or exhaust the memory of the process when deserializing untrusted data.

CA5363: Do Not Disable Request Validation

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Request validation is a feature in ASP.NET that examines HTTP requests and determines whether they contain potentially dangerous content. This check adds protection from markup or code in the URL query string, cookies, or posted form values that might have been added for malicious purposes. So, it is generally desirable and should be left enabled for defense in depth.

CA5364: Do Not Use Deprecated Security Protocols

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Using a deprecated security protocol rather than the system default is risky.

CA5365: Do Not Disable HTTP Header Checking

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

HTTP header checking enables encoding of the carriage return and newline characters, \r and \n, that are found in response headers. This encoding can help to avoid injection attacks that exploit an application that echoes untrusted data contained by the header.

CA5366: Use XmlReader For DataSet Read Xml

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Processing XML from untrusted data may load dangerous external references, which should be restricted by using an XmlReader with a secure resolver or with DTD processing disabled.

CA5367: Do Not Serialize Types With Pointer Fields

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Pointers are not "type safe" in the sense that you cannot guarantee the correctness of the memory they point at. So, serializing types with pointer fields is dangerous, as it may allow an attacker to control the pointer.

CA5368: Set ViewStateUserKey For Classes Derived From Page

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Setting the ViewStateUserKey property can help you prevent attacks on your application by allowing you to assign an identifier to the view-state variable for individual users so that they cannot use the variable to generate an attack. Otherwise, there will be cross-site request forgery vulnerabilities.

CA5369: Use XmlReader For Deserialize

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Processing XML from untrusted data may load dangerous external references, which should be restricted by using an XmlReader with a secure resolver or with DTD processing disabled.

CA5370: Use XmlReader For Validating Reader

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Processing XML from untrusted data may load dangerous external references, which should be restricted by using an XmlReader with a secure resolver or with DTD processing disabled.

CA5371: Use XmlReader For Schema Read

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Processing XML from untrusted data may load dangerous external references, which should be restricted by using an XmlReader with a secure resolver or with DTD processing disabled.

CA5372: Use XmlReader For XPathDocument

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Processing XML from untrusted data may load dangerous external references, which should be restricted by using an XmlReader with a secure resolver or with DTD processing disabled.

CA5373: Do not use obsolete key derivation function

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Password-based key derivation should use PBKDF2 with SHA-2. Avoid using PasswordDeriveBytes since it generates a PBKDF1 key. Avoid using Rfc2898DeriveBytes.CryptDeriveKey since it doesn't use the iteration count or salt.

CA5374: Do Not Use XslTransform

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Do not use XslTransform. It does not restrict potentially dangerous external references.

CA5375: Do Not Use Account Shared Access Signature

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Shared Access Signatures(SAS) are a vital part of the security model for any application using Azure Storage, they should provide limited and safe permissions to your storage account to clients that don't have the account key. All of the operations available via a service SAS are also available via an account SAS, that is, account SAS is too powerful. So it is recommended to use Service SAS to delegate access more carefully.

CA5376: Use SharedAccessProtocol HttpsOnly

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

HTTPS encrypts network traffic. Use HttpsOnly, rather than HttpOrHttps, to ensure network traffic is always encrypted to help prevent disclosure of sensitive data.

CA5377: Use Container Level Access Policy

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

No access policy identifier is specified, making tokens non-revocable.

CA5378: Do not disable ServicePointManagerSecurityProtocols

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Do not set Switch.System.ServiceModel.DisableUsingServicePointManagerSecurityProtocols to true. Setting this switch limits Windows Communication Framework (WCF) to using Transport Layer Security (TLS) 1.0, which is insecure and obsolete.

CA5379: Do Not Use Weak Key Derivation Function Algorithm

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Some implementations of the Rfc2898DeriveBytes class allow for a hash algorithm to be specified in a constructor parameter or overwritten in the HashAlgorithm property. If a hash algorithm is specified, then it should be SHA-256 or higher.

CA5380: Do Not Add Certificates To Root Store

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

By default, the Trusted Root Certification Authorities certificate store is configured with a set of public CAs that has met the requirements of the Microsoft Root Certificate Program. Since all trusted root CAs can issue certificates for any domain, an attacker can pick a weak or coercible CA that you install by yourself to target for an attack – and a single vulnerable, malicious or coercible CA undermines the security of the entire system. To make matters worse, these attacks can go unnoticed quite easily.

CA5381: Ensure Certificates Are Not Added To Root Store

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

By default, the Trusted Root Certification Authorities certificate store is configured with a set of public CAs that has met the requirements of the Microsoft Root Certificate Program. Since all trusted root CAs can issue certificates for any domain, an attacker can pick a weak or coercible CA that you install by yourself to target for an attack – and a single vulnerable, malicious or coercible CA undermines the security of the entire system. To make matters worse, these attacks can go unnoticed quite easily.

CA5382: Use Secure Cookies In ASP.Net Core

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Applications available over HTTPS must use secure cookies.

CA5383: Ensure Use Secure Cookies In ASP.Net Core

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Applications available over HTTPS must use secure cookies.

CA5384: Do Not Use Digital Signature Algorithm (DSA)

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

DSA is too weak to use.

CA5385: Use Rivest–Shamir–Adleman (RSA) Algorithm With Sufficient Key Size

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Encryption algorithms are vulnerable to brute force attacks when too small a key size is used.

CA5386: Avoid hardcoding SecurityProtocolType value

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Avoid hardcoding SecurityProtocolType {0}, and instead use SecurityProtocolType.SystemDefault to allow the operating system to choose the best Transport Layer Security protocol to use.

CA5387: Do Not Use Weak Key Derivation Function With Insufficient Iteration Count

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deriving cryptographic keys from user-provided inputs such as password, use sufficient iteration count (at least 100k).

CA5388: Ensure Sufficient Iteration Count When Using Weak Key Derivation Function

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When deriving cryptographic keys from user-provided inputs such as password, use sufficient iteration count (at least 100k).

CA5389: Do Not Add Archive Item's Path To The Target File System Path

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

When extracting files from an archive and using the archive item's path, check if the path is safe. Archive path can be relative and can lead to file system access outside of the expected file system target path, leading to malicious config changes and remote code execution via lay-and-wait technique.

CA5390: Do not hard-code encryption key

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

SymmetricAlgorithm's .Key property, or a method's rgbKey parameter, should never be a hard-coded value.

CA5391: Use antiforgery tokens in ASP.NET Core MVC controllers

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Handling a POST, PUT, PATCH, or DELETE request without validating an antiforgery token may be vulnerable to cross-site request forgery attacks. A cross-site request forgery attack can send malicious requests from an authenticated user to your ASP.NET Core MVC controller.

CA5392: Use DefaultDllImportSearchPaths attribute for P/Invokes

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

By default, P/Invokes using DllImportAttribute probe a number of directories, including the current working directory for the library to load. This can be a security issue for certain applications, leading to DLL hijacking.

CA5393: Do not use unsafe DllImportSearchPath value

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

There could be a malicious DLL in the default DLL search directories. Or, depending on where your application is run from, there could be a malicious DLL in the application's directory. Use a DllImportSearchPath value that specifies an explicit search path instead. The DllImportSearchPath flags that this rule looks for can be configured in .editorconfig.

CA5394: Do not use insecure randomness

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Using a cryptographically weak pseudo-random number generator may allow an attacker to predict what security-sensitive value will be generated. Use a cryptographically strong random number generator if an unpredictable value is required, or ensure that weak pseudo-random numbers aren't used in a security-sensitive manner.

CA5395: Miss HttpVerb attribute for action methods

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

All the methods that create, edit, delete, or otherwise modify data do so in the [HttpPost] overload of the method, which needs to be protected with the anti forgery attribute from request forgery. Performing a GET operation should be a safe operation that has no side effects and doesn't modify your persisted data.

CA5396: Set HttpOnly to true for HttpCookie

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

As a defense in depth measure, ensure security sensitive HTTP cookies are marked as HttpOnly. This indicates web browsers should disallow scripts from accessing the cookies. Injected malicious scripts are a common way of stealing cookies.

CA5397: Do not use deprecated SslProtocols values

Item Value
Category Security
Enabled True
Severity Warning
CodeFix False

Rule description

Older protocol versions of Transport Layer Security (TLS) are less secure than TLS 1.2 and TLS 1.3, and are more likely to have new vulnerabilities. Avoid older protocol versions to minimize risk.

CA5398: Avoid hardcoded SslProtocols values

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Current Transport Layer Security protocol versions may become deprecated if vulnerabilities are found. Avoid hardcoding SslProtocols values to keep your application secure. Use 'None' to let the Operating System choose a version.

CA5399: HttpClients should enable certificate revocation list checks

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Using HttpClient without providing a platform specific handler (WinHttpHandler or CurlHandler or HttpClientHandler) where the CheckCertificateRevocationList property is set to true, will allow revoked certificates to be accepted by the HttpClient as valid.

CA5400: Ensure HttpClient certificate revocation list check is not disabled

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Using HttpClient without providing a platform specific handler (WinHttpHandler or CurlHandler or HttpClientHandler) where the CheckCertificateRevocationList property is set to true, will allow revoked certificates to be accepted by the HttpClient as valid.

CA5401: Do not use CreateEncryptor with non-default IV

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Symmetric encryption should always use a non-repeatable initialization vector to prevent dictionary attacks.

CA5402: Use CreateEncryptor with the default IV

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Symmetric encryption should always use a non-repeatable initialization vector to prevent dictionary attacks.

CA5403: Do not hard-code certificate

Item Value
Category Security
Enabled False
Severity Warning
CodeFix False

Rule description

Hard-coded certificates in source code are vulnerable to being exploited.

IL3000: Avoid using accessing Assembly file path when publishing as a single-file

Item Value
Category Publish
Enabled True
Severity Warning
CodeFix False

Rule description

'{0}' always returns an empty string for assemblies embedded in a single-file app. If the path to the app directory is needed, consider calling 'System.AppContext.BaseDirectory'.

IL3001: Avoid using accessing Assembly file path when publishing as a single-file

Item Value
Category Publish
Enabled True
Severity Warning
CodeFix False

Rule description

'{0}' will throw for assemblies embedded in a single-file app