Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 2.62 KB

README.md

File metadata and controls

39 lines (29 loc) · 2.62 KB
Raw

fastJSON5

Very fast, conformant, and polymorphic JSON5 serializer.

Package Name Release (NuGet) Preview (NuGet)
fastJSON5 NuGet NuGet

The fastJSON how to is also applicable to this project, but using the fastJSON5 namespace and the JSON5 class name etc.

Supported platforms:

  • .NET Framework 4.0
  • .NET Framework 4.5
  • .NET Standard 1.5 (limited support)
  • .NET Standard 2.0
  • .NET Standard 2.1
  • .NET Core 1.0 (limited support)
  • .NET Core 2.0
  • .NET Core 2.1
  • .NET Core 3.0
  • .NET Core 3.1
  • .NET 5.0
  • .NET 6.0
  • .NET 7.0
  • And any platforms compatible with the above tfms

Limited support: you should test that the code works on each specific runtime you plan to build for as required APIs may not be available at runtime.

When building the project for yourself, open the fastJSONCore.sln solution and build the fastJSON5Builder project to create the executables. Use the fastJSON project at fastJSONcore/fastJSON.csproj (fastJSON in the sln file) to modify the library files. The UnitTests/UnitTestsCore.csproj project (UnitTestsCore in the sln file) is used to do the testing, so use it for anything relating to tests. The UnitTests/UnitTests.csproj project (UnitTests in the sln file) is the test project for .NET Framework. You may encounter issues building if you have the fastJSON.csproj file open in Visual Studio, try closing it if you do.

Other files: history.txt - history of the fastJSON project, history_json5.txt - history of the fastJSON5 project, fastJSON.nuspec - used to create the nuget package, fastJSON5Renamer - used to rename the relevant classes and namespaces to JSON5 from JSON.

Security Warning (only applicable if UseExtensions is manually set to true)

It has come to my attention from the HP Enterprise Security Group that using the $type extension has the potential to be unsafe, so use it with common sense and known json sources and not public facing ones to be safe.

Security Warning Update (only applicable if UseExtensions is manually set to true)

I have added JSONParameters.BadListTypeChecking which defaults to true to check for known $type attack vectors from the paper published from HP Enterprise Security Group, when enabled it will throw an exception and stop processing the json.