2009-04-14 Sebastien Pouliot <sebastien@ximian.com>
[mono.git] / mono / metadata / security-core-clr.c
1 /*
2  * security-core-clr.c: CoreCLR security
3  *
4  * Authors:
5  *      Mark Probst <mark.probst@gmail.com>
6  *      Sebastien Pouliot  <sebastien@ximian.com>
7  *
8  * Copyright 2007-2009 Novell, Inc (http://www.novell.com)
9  */
10
11 #include <mono/metadata/class-internals.h>
12 #include <mono/metadata/security-manager.h>
13 #include <mono/metadata/assembly.h>
14 #include <mono/metadata/appdomain.h>
15 #include <mono/metadata/verify-internals.h>
16 #include <mono/metadata/object.h>
17 #include <mono/metadata/exception.h>
18
19 #include "security-core-clr.h"
20
21 gboolean mono_security_core_clr_test = FALSE;
22
23 static MonoClass*
24 security_critical_attribute (void)
25 {
26         static MonoClass *class = NULL;
27
28         if (!class) {
29                 class = mono_class_from_name (mono_defaults.corlib, "System.Security", 
30                         "SecurityCriticalAttribute");
31         }
32         g_assert (class);
33         return class;
34 }
35
36 static MonoClass*
37 security_safe_critical_attribute (void)
38 {
39         static MonoClass *class = NULL;
40
41         if (!class) {
42                 class = mono_class_from_name (mono_defaults.corlib, "System.Security", 
43                         "SecuritySafeCriticalAttribute");
44         }
45         g_assert (class);
46         return class;
47 }
48
49 /*
50  * mono_security_core_clr_check_inheritance:
51  *
52  *      Determine if the specified class can inherit from its parent using 
53  *      the CoreCLR inheritance rules.
54  *
55  *      Base Type       Allow Derived Type
56  *      ------------    ------------------
57  *      Transparent     Transparent, SafeCritical, Critical
58  *      SafeCritical    SafeCritical, Critical
59  *      Critical        Critical
60  *
61  *      Reference: http://msdn.microsoft.com/en-us/magazine/cc765416.aspx#id0190030
62  */
63 void
64 mono_security_core_clr_check_inheritance (MonoClass *class)
65 {
66         MonoSecurityCoreCLRLevel class_level, parent_level;
67         MonoClass *parent = class->parent;
68
69         if (!parent)
70                 return;
71
72         class_level = mono_security_core_clr_class_level (class);
73         parent_level = mono_security_core_clr_class_level (parent);
74
75         if (class_level < parent_level)
76                 mono_class_set_failure (class, MONO_EXCEPTION_TYPE_LOAD, NULL);
77 }
78
79 /*
80  * mono_security_core_clr_check_override:
81  *
82  *      Determine if the specified override can "legally" override the 
83  *      specified base method using the CoreCLR inheritance rules.
84  *
85  *      Base (virtual/interface)        Allowed override
86  *      ------------------------        -------------------------
87  *      Transparent                     Transparent, SafeCritical
88  *      SafeCritical                    Transparent, SafeCritical
89  *      Critical                        Critical
90  *
91  *      Reference: http://msdn.microsoft.com/en-us/magazine/cc765416.aspx#id0190030
92  */
93 void
94 mono_security_core_clr_check_override (MonoClass *class, MonoMethod *override, MonoMethod *base)
95 {
96         MonoSecurityCoreCLRLevel base_level = mono_security_core_clr_method_level (base, FALSE);
97         MonoSecurityCoreCLRLevel override_level = mono_security_core_clr_method_level (override, FALSE);
98         /* if the base method is decorated with [SecurityCritical] then the overrided method MUST be too */
99         if (base_level == MONO_SECURITY_CORE_CLR_CRITICAL) {
100                 if (override_level != MONO_SECURITY_CORE_CLR_CRITICAL)
101                         mono_class_set_failure (class, MONO_EXCEPTION_TYPE_LOAD, NULL);
102         } else {
103                 /* base is [SecuritySafeCritical] or [SecurityTransparent], override MUST NOT be [SecurityCritical] */
104                 if (override_level == MONO_SECURITY_CORE_CLR_CRITICAL)
105                         mono_class_set_failure (class, MONO_EXCEPTION_TYPE_LOAD, NULL);
106         }
107 }
108
109 /*
110  * get_caller_no_reflection_related:
111  *
112  *      Find the first managed caller that is either:
113  *      (a) located outside the platform code assemblies; or
114  *      (b) not related to reflection and delegates
115  *
116  *      Returns TRUE to stop the stackwalk, FALSE to continue to the next frame.
117  */
118 static gboolean
119 get_caller_no_reflection_related (MonoMethod *m, gint32 no, gint32 ilo, gboolean managed, gpointer data)
120 {
121         MonoMethod **dest = data;
122         const char *ns;
123
124         /* skip unmanaged frames */
125         if (!managed)
126                 return FALSE;
127
128         if (m->wrapper_type != MONO_WRAPPER_NONE)
129                 return FALSE;
130
131         /* quick out (any namespace not starting with an 'S' */
132         ns = m->klass->name_space;
133         if (!ns || (*ns != 'S')) {
134                 *dest = m;
135                 return TRUE;
136         }
137
138         /* stop if the method is not part of platform code */
139         if (!mono_security_core_clr_is_platform_image (m->klass->image)) {
140                 *dest = m;
141                 return TRUE;
142         }
143
144         /* any number of calls inside System.Reflection are allowed */
145         if (strcmp (ns, "System.Reflection") == 0)
146                 return FALSE;
147
148         /* any number of calls inside System.Reflection are allowed */
149         if (strcmp (ns, "System.Reflection.Emit") == 0)
150                 return FALSE;
151
152         /* calls from System.Delegate are also possible and allowed */
153         if (strcmp (ns, "System") == 0) {
154                 const char *kname = m->klass->name;
155                 if ((*kname == 'D') && (strcmp (kname, "Delegate") == 0))
156                         return FALSE;
157                 if ((*kname == 'M') && (strcmp (kname, "MulticastDelegate")) == 0)
158                         return FALSE;
159                 if ((*kname == 'A') && (strcmp (kname, "Activator") == 0))
160                         return FALSE;
161         }
162
163         if (m == *dest) {
164                 *dest = NULL;
165                 return FALSE;
166         }
167
168         *dest = m;
169         return TRUE;
170 }
171
172 /*
173  * get_reflection_caller:
174  * 
175  *      Walk to the first managed method outside:
176  *      - System.Reflection* namespaces
177  *      - System.[MulticastDelegate]Delegate or Activator type
178  *      - platform code
179  *      and return a pointer to its MonoMethod.
180  *
181  *      This is required since CoreCLR checks needs to be done on this "real" caller.
182  */
183 static MonoMethod*
184 get_reflection_caller (void)
185 {
186         MonoMethod *m = NULL;
187         mono_stack_walk_no_il (get_caller_no_reflection_related, &m);
188         if (!m)
189                 g_warning ("could not find a caller outside reflection");
190         return m;
191 }
192
193 /*
194  * check_field_access:
195  *
196  *      Return TRUE if the caller method can access the specified field, FALSE otherwise.
197  */
198 static gboolean
199 check_field_access (MonoMethod *caller, MonoClassField *field)
200 {
201         /* if get_reflection_caller returns NULL then we assume the caller has NO privilege */
202         if (caller) {
203                 MonoClass *klass = (mono_field_get_flags (field) & FIELD_ATTRIBUTE_STATIC) ? NULL : mono_field_get_parent (field);
204                 return mono_method_can_access_field_full (caller, field, klass);
205         }
206         return FALSE;
207 }
208
209 /*
210  * check_method_access:
211  *
212  *      Return TRUE if the caller method can access the specified callee method, FALSE otherwise.
213  */
214 static gboolean
215 check_method_access (MonoMethod *caller, MonoMethod *callee)
216 {
217         /* if get_reflection_caller returns NULL then we assume the caller has NO privilege */
218         if (caller) {
219                 MonoClass *klass = (callee->flags & METHOD_ATTRIBUTE_STATIC) ? NULL : callee->klass;
220                 return mono_method_can_access_method_full (caller, callee, klass);
221         }
222         return FALSE;
223 }
224
225 /*
226  * mono_security_core_clr_ensure_reflection_access_field:
227  *
228  *      Ensure that the specified field can be used with reflection since 
229  *      Transparent code cannot access to Critical fields and can only use
230  *      them if they are visible from it's point of view.
231  *
232  *      A FieldAccessException is thrown if the field is cannot be accessed.
233  */
234 void
235 mono_security_core_clr_ensure_reflection_access_field (MonoClassField *field)
236 {
237         MonoMethod *caller = get_reflection_caller ();
238         /* CoreCLR restrictions applies to Transparent code/caller */
239         if (mono_security_core_clr_method_level (caller, TRUE) != MONO_SECURITY_CORE_CLR_TRANSPARENT)
240                 return;
241
242         /* Transparent code cannot [get|set]value on Critical fields */
243         if (mono_security_core_clr_class_level (mono_field_get_parent (field)) == MONO_SECURITY_CORE_CLR_CRITICAL)
244                 mono_raise_exception (mono_get_exception_field_access ());
245
246         /* also it cannot access a fields that is not visible from it's (caller) point of view */
247         if (!check_field_access (caller, field))
248                 mono_raise_exception (mono_get_exception_field_access ());
249 }
250
251 /*
252  * mono_security_core_clr_ensure_reflection_access_method:
253  *
254  *      Ensure that the specified method can be used with reflection since
255  *      Transparent code cannot call Critical methods and can only call them
256  *      if they are visible from it's point of view.
257  *
258  *      A MethodAccessException is thrown if the field is cannot be accessed.
259  */
260 void
261 mono_security_core_clr_ensure_reflection_access_method (MonoMethod *method)
262 {
263         MonoMethod *caller = get_reflection_caller ();
264         /* CoreCLR restrictions applies to Transparent code/caller */
265         if (mono_security_core_clr_method_level (caller, TRUE) != MONO_SECURITY_CORE_CLR_TRANSPARENT)
266                 return;
267
268         /* Transparent code cannot invoke, even using reflection, Critical code */
269         if (mono_security_core_clr_method_level (method, TRUE) == MONO_SECURITY_CORE_CLR_CRITICAL)
270                 mono_raise_exception (mono_get_exception_method_access ());
271
272         /* also it cannot invoke a method that is not visible from it's (caller) point of view */
273         if (!check_method_access (caller, method))
274                 mono_raise_exception (mono_get_exception_method_access ());
275 }
276
277 /*
278  * can_avoid_corlib_reflection_delegate_optimization:
279  *
280  *      Mono's mscorlib use delegates to optimize PropertyInfo and EventInfo
281  *      reflection calls. This requires either a bunch of additional, and not
282  *      really required, [SecuritySafeCritical] in the class libraries or 
283  *      (like this) a way to skip them. As a bonus we also avoid the stack
284  *      walk to find the caller.
285  *
286  *      Return TRUE if we can skip this "internal" delegate creation, FALSE
287  *      otherwise.
288  */
289 static gboolean
290 can_avoid_corlib_reflection_delegate_optimization (MonoMethod *method)
291 {
292         if (!mono_security_core_clr_is_platform_image (method->klass->image))
293                 return FALSE;
294
295         if (strcmp (method->klass->name_space, "System.Reflection") != 0)
296                 return FALSE;
297
298         if (strcmp (method->klass->name, "MonoProperty") == 0) {
299                 if ((strcmp (method->name, "GetterAdapterFrame") == 0) || strcmp (method->name, "StaticGetterAdapterFrame") == 0)
300                         return TRUE;
301         } else if (strcmp (method->klass->name, "EventInfo") == 0) {
302                 if ((strcmp (method->name, "AddEventFrame") == 0) || strcmp (method->name, "StaticAddEventAdapterFrame") == 0)
303                         return TRUE;
304         }
305
306         return FALSE;
307 }
308
309 /*
310  * mono_security_core_clr_ensure_delegate_creation:
311  *
312  *      Return TRUE if a delegate can be created on the specified method. 
313  *      CoreCLR also affect the binding, so throwOnBindFailure must be 
314  *      FALSE to let this function return (FALSE) normally, otherwise (if
315  *      throwOnBindFailure is TRUE) itwill throw an ArgumentException.
316  *
317  *      A MethodAccessException is thrown if the specified method is not
318  *      visible from the caller point of view.
319  */
320 gboolean
321 mono_security_core_clr_ensure_delegate_creation (MonoMethod *method, gboolean throwOnBindFailure)
322 {
323         MonoMethod *caller;
324
325         /* note: mscorlib creates delegates to avoid reflection (optimization), we ignore those cases */
326         if (can_avoid_corlib_reflection_delegate_optimization (method))
327                 return TRUE;
328
329         caller = get_reflection_caller ();
330         /* if the "real" caller is not Transparent then it do can anything */
331         if (mono_security_core_clr_method_level (caller, TRUE) != MONO_SECURITY_CORE_CLR_TRANSPARENT)
332                 return TRUE;
333
334         /* otherwise it (as a Transparent caller) cannot create a delegate on a Critical method... */
335         if (mono_security_core_clr_method_level (method, TRUE) == MONO_SECURITY_CORE_CLR_CRITICAL) {
336                 /* but this throws only if 'throwOnBindFailure' is TRUE */
337                 if (!throwOnBindFailure)
338                         return FALSE;
339
340                 mono_raise_exception (mono_get_exception_argument ("method", "Transparent code cannot call Critical code"));
341         }
342         
343         /* also it cannot create the delegate on a method that is not visible from it's (caller) point of view */
344         if (!check_method_access (caller, method))
345                 mono_raise_exception (mono_get_exception_method_access ());
346
347         return TRUE;
348 }
349
350 /*
351  * mono_security_core_clr_ensure_dynamic_method_resolved_object:
352  *
353  *      Called from mono_reflection_create_dynamic_method (reflection.c) to add some extra checks required for CoreCLR.
354  *      Dynamic methods needs to check to see if the objects being used (e.g. methods, fields) comes from platform code
355  *      and do an accessibility check in this case. Otherwise (i.e. user/application code) can be used without this extra
356  *      accessbility check.
357  */
358 MonoException*
359 mono_security_core_clr_ensure_dynamic_method_resolved_object (gpointer ref, MonoClass *handle_class)
360 {
361         /* XXX find/create test cases for other handle_class XXX */
362         if (handle_class == mono_defaults.fieldhandle_class) {
363                 MonoClassField *field = (MonoClassField*) ref;
364                 MonoClass *klass = mono_field_get_parent (field);
365                 /* fields coming from platform code have extra protection (accessibility check) */
366                 if (mono_security_core_clr_is_platform_image (klass->image)) {
367                         MonoMethod *caller = get_reflection_caller ();
368                         /* XXX Critical code probably can do this / need some test cases (safer off otherwise) XXX */
369                         if (!check_field_access (caller, field))
370                                 return mono_get_exception_field_access ();
371                 }
372         } else if (handle_class == mono_defaults.methodhandle_class) {
373                 MonoMethod *method = (MonoMethod*) ref;
374                 /* methods coming from platform code have extra protection (accessibility check) */
375                 if (mono_security_core_clr_is_platform_image (method->klass->image)) {
376                         MonoMethod *caller = get_reflection_caller ();
377                         /* XXX Critical code probably can do this / need some test cases (safer off otherwise) XXX */
378                         if (!check_method_access (caller, method))
379                                 return mono_get_exception_method_access ();
380                 }
381         }
382         return NULL;
383 }
384
385 /*
386  * mono_security_core_clr_level_from_cinfo:
387  *
388  *      Return the MonoSecurityCoreCLRLevel that match the attribute located
389  *      in the specified custom attributes. If no attribute is present it 
390  *      defaults to MONO_SECURITY_CORE_CLR_TRANSPARENT, which is the default
391  *      level for all code under the CoreCLR.
392  */
393 static MonoSecurityCoreCLRLevel
394 mono_security_core_clr_level_from_cinfo (MonoCustomAttrInfo *cinfo, MonoImage *image)
395 {
396         int level = MONO_SECURITY_CORE_CLR_TRANSPARENT;
397
398         if (cinfo && mono_custom_attrs_has_attr (cinfo, security_safe_critical_attribute ()))
399                 level = MONO_SECURITY_CORE_CLR_SAFE_CRITICAL;
400         if (cinfo && mono_custom_attrs_has_attr (cinfo, security_critical_attribute ()))
401                 level = MONO_SECURITY_CORE_CLR_CRITICAL;
402
403         return level;
404 }
405
406 /*
407  * mono_security_core_clr_class_level:
408  *
409  *      Return the MonoSecurityCoreCLRLevel for the specified class.
410  */
411 MonoSecurityCoreCLRLevel
412 mono_security_core_clr_class_level (MonoClass *class)
413 {
414         MonoCustomAttrInfo *cinfo;
415         MonoSecurityCoreCLRLevel level = MONO_SECURITY_CORE_CLR_TRANSPARENT;
416
417         /* non-platform code is always Transparent - whatever the attributes says */
418         if (!mono_security_core_clr_test && !mono_security_core_clr_is_platform_image (class->image))
419                 return level;
420
421         cinfo = mono_custom_attrs_from_class (class);
422         if (cinfo) {
423                 level = mono_security_core_clr_level_from_cinfo (cinfo, class->image);
424                 mono_custom_attrs_free (cinfo);
425         }
426
427         if (level == MONO_SECURITY_CORE_CLR_TRANSPARENT && class->nested_in)
428                 level = mono_security_core_clr_class_level (class->nested_in);
429
430         return level;
431 }
432
433 /*
434  * mono_security_core_clr_method_level:
435  *
436  *      Return the MonoSecurityCoreCLRLevel for the specified method.
437  *      If with_class_level is TRUE then the type (class) will also be
438  *      checked, otherwise this will only report the information about
439  *      the method itself.
440  */
441 MonoSecurityCoreCLRLevel
442 mono_security_core_clr_method_level (MonoMethod *method, gboolean with_class_level)
443 {
444         MonoCustomAttrInfo *cinfo;
445         MonoSecurityCoreCLRLevel level = MONO_SECURITY_CORE_CLR_TRANSPARENT;
446
447         /* if get_reflection_caller returns NULL then we assume the caller has NO privilege */
448         if (!method)
449                 return level;
450
451         /* non-platform code is always Transparent - whatever the attributes says */
452         if (!mono_security_core_clr_test && !mono_security_core_clr_is_platform_image (method->klass->image))
453                 return level;
454
455         cinfo = mono_custom_attrs_from_method (method);
456         if (cinfo) {
457                 level = mono_security_core_clr_level_from_cinfo (cinfo, method->klass->image);
458                 mono_custom_attrs_free (cinfo);
459         }
460
461         if (with_class_level && level == MONO_SECURITY_CORE_CLR_TRANSPARENT)
462                 level = mono_security_core_clr_class_level (method->klass);
463
464         return level;
465 }
466
467 /*
468  * mono_security_core_clr_is_platform_image:
469  *
470  *   Return the (cached) boolean value indicating if this image represent platform code
471  */
472 gboolean
473 mono_security_core_clr_is_platform_image (MonoImage *image)
474 {
475         return image->core_clr_platform_code;
476 }
477
478 /*
479  * default_platform_check:
480  *
481  *      Default platform check. Always return FALSE.
482  */
483 static gboolean
484 default_platform_check (const char *image_name)
485 {
486         return FALSE;
487 }
488
489 static MonoCoreClrPlatformCB platform_callback = default_platform_check;
490
491 /*
492  * mono_security_core_clr_determine_platform_image:
493  *
494  *      Call the supplied callback (from mono_security_set_core_clr_platform_callback) 
495  *      to determine if this image represents platform code.
496  */
497 gboolean
498 mono_security_core_clr_determine_platform_image (MonoImage *image)
499 {
500         return platform_callback (image->name);
501 }
502
503 /*
504  * mono_security_enable_core_clr:
505  *
506  *   Enable the verifier and the CoreCLR security model
507  */
508 void
509 mono_security_enable_core_clr ()
510 {
511         mono_verifier_set_mode (MONO_VERIFIER_MODE_VERIFIABLE);
512         mono_security_set_mode (MONO_SECURITY_MODE_CORE_CLR);
513 }
514
515 /*
516  * mono_security_set_core_clr_platform_callback:
517  *
518  *      Set the callback function that will be used to determine if an image
519  *      is part, or not, of the platform code.
520  */
521 void
522 mono_security_set_core_clr_platform_callback (MonoCoreClrPlatformCB callback)
523 {
524         platform_callback = callback;
525 }
526