InvalidProtocolBufferException.cs 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. #region Copyright notice and license
  2. // Protocol Buffers - Google's data interchange format
  3. // Copyright 2008 Google Inc. All rights reserved.
  4. // https://developers.google.com/protocol-buffers/
  5. //
  6. // Redistribution and use in source and binary forms, with or without
  7. // modification, are permitted provided that the following conditions are
  8. // met:
  9. //
  10. // * Redistributions of source code must retain the above copyright
  11. // notice, this list of conditions and the following disclaimer.
  12. // * Redistributions in binary form must reproduce the above
  13. // copyright notice, this list of conditions and the following disclaimer
  14. // in the documentation and/or other materials provided with the
  15. // distribution.
  16. // * Neither the name of Google Inc. nor the names of its
  17. // contributors may be used to endorse or promote products derived from
  18. // this software without specific prior written permission.
  19. //
  20. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. #endregion
  32. using System;
  33. using System.IO;
  34. namespace XGame.Framework.Network.Protobuf
  35. {
  36. /// <summary>
  37. /// Thrown when a protocol message being parsed is invalid in some way,
  38. /// e.g. it contains a malformed varint or a negative byte length.
  39. /// </summary>
  40. public sealed class InvalidProtocolBufferException : IOException
  41. {
  42. public InvalidProtocolBufferException(string message)
  43. : base(message)
  44. {
  45. }
  46. public InvalidProtocolBufferException(string message, Exception innerException)
  47. : base(message, innerException)
  48. {
  49. }
  50. public static InvalidProtocolBufferException MoreDataAvailable()
  51. {
  52. return new InvalidProtocolBufferException(
  53. "Completed reading a message while more data was available in the stream.");
  54. }
  55. public static InvalidProtocolBufferException TruncatedMessage()
  56. {
  57. return new InvalidProtocolBufferException(
  58. "While parsing a protocol message, the input ended unexpectedly " +
  59. "in the middle of a field. This could mean either that the " +
  60. "input has been truncated or that an embedded message " +
  61. "misreported its own length.");
  62. }
  63. public static InvalidProtocolBufferException NegativeSize()
  64. {
  65. return new InvalidProtocolBufferException(
  66. "CodedInputStream encountered an embedded string or message " +
  67. "which claimed to have negative size.");
  68. }
  69. public static InvalidProtocolBufferException MalformedVarint()
  70. {
  71. return new InvalidProtocolBufferException(
  72. "CodedInputStream encountered a malformed varint.");
  73. }
  74. /// <summary>
  75. /// Creates an exception for an error condition of an invalid tag being encountered.
  76. /// </summary>
  77. public static InvalidProtocolBufferException InvalidTag()
  78. {
  79. return new InvalidProtocolBufferException(
  80. "Protocol message contained an invalid tag (zero).");
  81. }
  82. public static InvalidProtocolBufferException InvalidBase64(Exception innerException)
  83. {
  84. return new InvalidProtocolBufferException("Invalid base64 data", innerException);
  85. }
  86. public static InvalidProtocolBufferException InvalidEndTag()
  87. {
  88. return new InvalidProtocolBufferException(
  89. "Protocol message end-group tag did not match expected tag.");
  90. }
  91. public static InvalidProtocolBufferException RecursionLimitExceeded()
  92. {
  93. return new InvalidProtocolBufferException(
  94. "Protocol message had too many levels of nesting. May be malicious. " +
  95. "Use CodedInputStream.SetRecursionLimit() to increase the depth limit.");
  96. }
  97. public static InvalidProtocolBufferException JsonRecursionLimitExceeded()
  98. {
  99. return new InvalidProtocolBufferException(
  100. "Protocol message had too many levels of nesting. May be malicious. " +
  101. "Use JsonParser.Settings to increase the depth limit.");
  102. }
  103. public static InvalidProtocolBufferException SizeLimitExceeded()
  104. {
  105. return new InvalidProtocolBufferException(
  106. "Protocol message was too large. May be malicious. " +
  107. "Use CodedInputStream.SetSizeLimit() to increase the size limit.");
  108. }
  109. public static InvalidProtocolBufferException InvalidMessageStreamTag()
  110. {
  111. return new InvalidProtocolBufferException(
  112. "Stream of protocol messages had invalid tag. Expected tag is length-delimited field 1.");
  113. }
  114. }
  115. }