summary refs log tree commit diff
path: root/crypto/src/pkix/PkixCertPathValidatorException.cs
blob: a477f7dc47f02643671fa8c53659ff84adfa8cfc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
using System;
using Org.BouncyCastle.Security;

namespace Org.BouncyCastle.Pkix
{
	/**
	 * An exception indicating one of a variety of problems encountered when 
	 * validating a certification path. <br />
	 * <br />
	 * A <code>CertPathValidatorException</code> provides support for wrapping
	 * exceptions. The {@link #getCause getCause} method returns the throwable, 
	 * if any, that caused this exception to be thrown. <br />
	 * <br />
	 * A <code>CertPathValidatorException</code> may also include the 
	 * certification path that was being validated when the exception was thrown 
	 * and the index of the certificate in the certification path that caused the 
	 * exception to be thrown. Use the {@link #getCertPath getCertPath} and
	 * {@link #getIndex getIndex} methods to retrieve this information.<br />
	 * <br />
	 * <b>Concurrent Access</b><br />
	 * <br />
	 * Unless otherwise specified, the methods defined in this class are not
	 * thread-safe. Multiple threads that need to access a single
	 * object concurrently should synchronize amongst themselves and
	 * provide the necessary locking. Multiple threads each manipulating
	 * separate objects need not synchronize.
	 *
	 * @see CertPathValidator
	 **/
#if !(NETCF_1_0 || NETCF_2_0 || SILVERLIGHT || PORTABLE)
    [Serializable]
#endif
    public class PkixCertPathValidatorException
        : GeneralSecurityException
	{
		private Exception cause;
		private PkixCertPath certPath;
		private int index = -1;

		public PkixCertPathValidatorException() : base() { }

		/// <summary>
		/// Creates a <code>PkixCertPathValidatorException</code> with the given detail
		/// message. A detail message is a <code>String</code> that describes this
		/// particular exception. 
		/// </summary>
		/// <param name="message">the detail message</param>
		public PkixCertPathValidatorException(string message) : base(message) { }

		/// <summary>
		/// Creates a <code>PkixCertPathValidatorException</code> with the specified
		/// detail message and cause.
		/// </summary>
		/// <param name="message">the detail message</param>
		/// <param name="cause">the cause (which is saved for later retrieval by the
		/// {@link #getCause getCause()} method). (A <code>null</code>
		/// value is permitted, and indicates that the cause is
		/// nonexistent or unknown.)</param>
		public PkixCertPathValidatorException(string message, Exception cause) : base(message)
		{
			this.cause = cause;
		}

		/// <summary>
		/// Creates a <code>PkixCertPathValidatorException</code> with the specified
		/// detail message, cause, certification path, and index.
		/// </summary>
		/// <param name="message">the detail message (or <code>null</code> if none)</param>
		/// <param name="cause">the cause (or <code>null</code> if none)</param>
		/// <param name="certPath">the certification path that was in the process of being
		/// validated when the error was encountered</param>
		/// <param name="index">the index of the certificate in the certification path that</param>																																																																																   * 
		public PkixCertPathValidatorException(
			string			message,
			Exception		cause,
			PkixCertPath	certPath,
			int				index)
			: base(message)
		{
			if (certPath == null && index != -1)
			{
				throw new ArgumentNullException(
					"certPath = null and index != -1");
			}
			if (index < -1
				|| (certPath != null && index >= certPath.Certificates.Count))
			{
				throw new IndexOutOfRangeException(
					" index < -1 or out of bound of certPath.getCertificates()");
			}

			this.cause = cause;
			this.certPath = certPath;
			this.index = index;
		}

		//
		// Prints a stack trace to a <code>PrintWriter</code>, including the
		// backtrace of the cause, if any.
		// 
		// @param pw
		//            the <code>PrintWriter</code> to use for output
		//
		//		public void printStackTrace(PrintWriter pw)
		//		{
		//			super.printStackTrace(pw);
		//			if (getCause() != null)
		//			{
		//				getCause().printStackTrace(pw);
		//			}
		//	}
		//}


		//	/**
		//	 * Creates a <code>CertPathValidatorException</code> that wraps the
		//	 * specified throwable. This allows any exception to be converted into a
		//	 * <code>CertPathValidatorException</code>, while retaining information
		//	 * about the wrapped exception, which may be useful for debugging. The
		//	 * detail message is set to (<code>cause==null ? null : cause.toString()
		//	 * </code>)
		//	 * (which typically contains the class and detail message of cause).
		//	 * 
		//	 * @param cause
		//	 *            the cause (which is saved for later retrieval by the
		//	 *            {@link #getCause getCause()} method). (A <code>null</code>
		//	 *            value is permitted, and indicates that the cause is
		//	 *            nonexistent or unknown.)
		//	 */
		//	public PkixCertPathValidatorException(Throwable cause)
		//	{
		//		this.cause = cause;
		//	}
		//

		/// <summary>
		/// Returns the detail message for this <code>CertPathValidatorException</code>.
		/// </summary>
		/// <returns>the detail message, or <code>null</code> if neither the message nor cause were specified</returns>
		public override string Message
		{
			get
			{
				string message = base.Message;

				if (message != null)
				{
					return message;
				}

				if (cause != null)
				{
					return cause.Message;
				}

				return null;
			}
		}

	/**
	 * Returns the certification path that was being validated when the
	 * exception was thrown.
	 * 
	 * @return the <code>CertPath</code> that was being validated when the
	 *         exception was thrown (or <code>null</code> if not specified)
	 */
		public PkixCertPath CertPath
		{
			get { return certPath; }
		}

	/**
	 * Returns the index of the certificate in the certification path that
	 * caused the exception to be thrown. Note that the list of certificates in
	 * a <code>CertPath</code> is zero based. If no index has been set, -1 is
	 * returned.
	 * 
	 * @return the index that has been set, or -1 if none has been set
	 */
	public int Index
	{
        get { return index; }
	}

//	/**
//	 * Returns the cause of this <code>CertPathValidatorException</code> or
//	 * <code>null</code> if the cause is nonexistent or unknown.
//	 * 
//	 * @return the cause of this throwable or <code>null</code> if the cause
//	 *         is nonexistent or unknown.
//	 */
//	public Throwable getCause()
//	{
//		return cause;
//	}
//
//	/**
//	 * Returns a string describing this exception, including a description of
//	 * the internal (wrapped) cause if there is one.
//	 * 
//	 * @return a string representation of this
//	 *         <code>CertPathValidatorException</code>
//	 */
//	public String toString()
//	{
//		StringBuffer sb = new StringBuffer();
//		String s = getMessage();
//		if (s != null)
//		{
//			sb.append(s);
//		}
//		if (getIndex() >= 0)
//		{
//			sb.append("index in certpath: ").append(getIndex()).append('\n');
//			sb.append(getCertPath());
//		}
//		return sb.toString();
//	}

	}
}