summaryrefslogtreecommitdiff
path: root/src/cuchaz/enigma/analysis/JarIndex.java
blob: 3aac8bd0092e2ddcad1ea8dd93a0962d8e5d8bc6 (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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
/*******************************************************************************
 * Copyright (c) 2014 Jeff Martin.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Public License v3.0
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/gpl.html
 * 
 * Contributors:
 *     Jeff Martin - initial API and implementation
 ******************************************************************************/
package cuchaz.enigma.analysis;

import java.lang.reflect.Modifier;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.jar.JarFile;

import javassist.CannotCompileException;
import javassist.CtBehavior;
import javassist.CtClass;
import javassist.CtConstructor;
import javassist.CtField;
import javassist.bytecode.AccessFlag;
import javassist.bytecode.Descriptor;
import javassist.bytecode.FieldInfo;
import javassist.expr.ConstructorCall;
import javassist.expr.ExprEditor;
import javassist.expr.FieldAccess;
import javassist.expr.MethodCall;
import javassist.expr.NewExpr;

import com.google.common.collect.HashMultimap;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Sets;

import cuchaz.enigma.Constants;
import cuchaz.enigma.bytecode.ClassRenamer;
import cuchaz.enigma.mapping.ArgumentEntry;
import cuchaz.enigma.mapping.BehaviorEntry;
import cuchaz.enigma.mapping.BehaviorEntryFactory;
import cuchaz.enigma.mapping.ClassEntry;
import cuchaz.enigma.mapping.ConstructorEntry;
import cuchaz.enigma.mapping.Entry;
import cuchaz.enigma.mapping.FieldEntry;
import cuchaz.enigma.mapping.JavassistUtil;
import cuchaz.enigma.mapping.MethodEntry;
import cuchaz.enigma.mapping.Translator;

public class JarIndex {
	
	private Set<ClassEntry> m_obfClassEntries;
	private TranslationIndex m_translationIndex;
	private Multimap<String,String> m_interfaces;
	private Map<Entry,Access> m_access;
	private Map<FieldEntry,ClassEntry> m_fieldClasses; // TODO: this will become obsolete!
	private Multimap<String,MethodEntry> m_methodImplementations;
	private Multimap<BehaviorEntry,EntryReference<BehaviorEntry,BehaviorEntry>> m_behaviorReferences;
	private Multimap<FieldEntry,EntryReference<FieldEntry,BehaviorEntry>> m_fieldReferences;
	private Multimap<String,String> m_innerClasses;
	private Map<String,String> m_outerClasses;
	private Map<String,BehaviorEntry> m_anonymousClasses;
	
	public JarIndex() {
		m_obfClassEntries = Sets.newHashSet();
		m_translationIndex = new TranslationIndex();
		m_interfaces = HashMultimap.create();
		m_access = Maps.newHashMap();
		m_fieldClasses = Maps.newHashMap();
		m_methodImplementations = HashMultimap.create();
		m_behaviorReferences = HashMultimap.create();
		m_fieldReferences = HashMultimap.create();
		m_innerClasses = HashMultimap.create();
		m_outerClasses = Maps.newHashMap();
		m_anonymousClasses = Maps.newHashMap();
	}
	
	public void indexJar(JarFile jar, boolean buildInnerClasses) {
		
		// step 1: read the class names
		for (ClassEntry classEntry : JarClassIterator.getClassEntries(jar)) {
			if (classEntry.isInDefaultPackage()) {
				// move out of default package
				classEntry = new ClassEntry(Constants.NonePackage + "/" + classEntry.getName());
			}
			m_obfClassEntries.add(classEntry);
		}
		
		// step 2: index field/method/constructor access
		for (CtClass c : JarClassIterator.classes(jar)) {
			ClassRenamer.moveAllClassesOutOfDefaultPackage(c, Constants.NonePackage);
			for (CtField field : c.getDeclaredFields()) {
				m_access.put(JavassistUtil.getFieldEntry(field), Access.get(field));
			}
			for (CtBehavior behavior : c.getDeclaredBehaviors()) {
				m_access.put(JavassistUtil.getBehaviorEntry(behavior), Access.get(behavior));
			}
		}
		
		// step 3: index extends, implements, fields, and methods
		for (CtClass c : JarClassIterator.classes(jar)) {
			ClassRenamer.moveAllClassesOutOfDefaultPackage(c, Constants.NonePackage);
			m_translationIndex.indexClass(c);
			String className = Descriptor.toJvmName(c.getName());
			for (String interfaceName : c.getClassFile().getInterfaces()) {
				className = Descriptor.toJvmName(className);
				interfaceName = Descriptor.toJvmName(interfaceName);
				if (className.equals(interfaceName)) {
					throw new IllegalArgumentException("Class cannot be its own interface! " + className);
				}
				m_interfaces.put(className, interfaceName);
			}
			for (CtField field : c.getDeclaredFields()) {
				indexField(field);
			}
			for (CtBehavior behavior : c.getDeclaredBehaviors()) {
				indexBehavior(behavior);
			}
		}
		
		// step 4: index field, method, constructor references
		for (CtClass c : JarClassIterator.classes(jar)) {
			ClassRenamer.moveAllClassesOutOfDefaultPackage(c, Constants.NonePackage);
			for (CtBehavior behavior : c.getDeclaredBehaviors()) {
				indexBehaviorReferences(behavior);
			}
		}
		
		if (buildInnerClasses) {
			// step 5: index inner classes and anonymous classes
			for (CtClass c : JarClassIterator.classes(jar)) {
				ClassRenamer.moveAllClassesOutOfDefaultPackage(c, Constants.NonePackage);
				String outerClassName = findOuterClass(c);
				if (outerClassName != null) {
					String innerClassName = c.getSimpleName();
					m_innerClasses.put(outerClassName, innerClassName);
					boolean innerWasAdded = m_outerClasses.put(innerClassName, outerClassName) == null;
					assert (innerWasAdded);
					
					BehaviorEntry enclosingBehavior = isAnonymousClass(c, outerClassName);
					if (enclosingBehavior != null) {
						m_anonymousClasses.put(innerClassName, enclosingBehavior);
						
						// DEBUG
						// System.out.println( "ANONYMOUS: " + outerClassName + "$" + innerClassName );
					} else {
						// DEBUG
						// System.out.println( "INNER: " + outerClassName + "$" + innerClassName );
					}
				}
			}
			
			// step 6: update other indices with inner class info
			Map<String,String> renames = Maps.newHashMap();
			for (Map.Entry<String,String> entry : m_outerClasses.entrySet()) {
				renames.put(Constants.NonePackage + "/" + entry.getKey(), entry.getValue() + "$" + entry.getKey());
			}
			EntryRenamer.renameClassesInSet(renames, m_obfClassEntries);
			m_translationIndex.renameClasses(renames);
			EntryRenamer.renameClassesInMultimap(renames, m_interfaces);
			EntryRenamer.renameClassesInMultimap(renames, m_methodImplementations);
			EntryRenamer.renameClassesInMultimap(renames, m_behaviorReferences);
			EntryRenamer.renameClassesInMultimap(renames, m_fieldReferences);
			EntryRenamer.renameClassesInMap(renames, m_access);
		}
	}
	
	private void indexField(CtField field) {
		// get the field entry
		String className = Descriptor.toJvmName(field.getDeclaringClass().getName());
		FieldEntry fieldEntry = new FieldEntry(new ClassEntry(className), field.getName());
		
		// is the field a class type?
		if (field.getSignature().startsWith("L")) {
			ClassEntry fieldTypeEntry = new ClassEntry(field.getSignature().substring(1, field.getSignature().length() - 1));
			m_fieldClasses.put(fieldEntry, fieldTypeEntry);
		}
	}
	
	private void indexBehavior(CtBehavior behavior) {
		// get the behavior entry
		final BehaviorEntry behaviorEntry = BehaviorEntryFactory.create(behavior);
		if (behaviorEntry instanceof MethodEntry) {
			MethodEntry methodEntry = (MethodEntry)behaviorEntry;
			
			// index implementation
			m_methodImplementations.put(behaviorEntry.getClassName(), methodEntry);
		}
		// looks like we don't care about constructors here
	}
	
	private void indexBehaviorReferences(CtBehavior behavior) {
		// index method calls
		final BehaviorEntry behaviorEntry = BehaviorEntryFactory.create(behavior);
		try {
			behavior.instrument(new ExprEditor() {
				@Override
				public void edit(MethodCall call) {
					MethodEntry calledMethodEntry = JavassistUtil.getMethodEntry(call);
					ClassEntry resolvedClassEntry = m_translationIndex.resolveEntryClass(calledMethodEntry);
					if (resolvedClassEntry != null && !resolvedClassEntry.equals(calledMethodEntry.getClassEntry())) {
						calledMethodEntry = new MethodEntry(
							resolvedClassEntry,
							calledMethodEntry.getName(),
							calledMethodEntry.getSignature()
						);
					}
					EntryReference<BehaviorEntry,BehaviorEntry> reference = new EntryReference<BehaviorEntry,BehaviorEntry>(
						calledMethodEntry,
						call.getMethodName(),
						behaviorEntry
					);
					m_behaviorReferences.put(calledMethodEntry, reference);
				}
				
				@Override
				public void edit(FieldAccess call) {
					FieldEntry calledFieldEntry = JavassistUtil.getFieldEntry(call);
					ClassEntry resolvedClassEntry = m_translationIndex.resolveEntryClass(calledFieldEntry);
					if (resolvedClassEntry != null && !resolvedClassEntry.equals(calledFieldEntry.getClassEntry())) {
						calledFieldEntry = new FieldEntry(resolvedClassEntry, call.getFieldName());
					}
					EntryReference<FieldEntry,BehaviorEntry> reference = new EntryReference<FieldEntry,BehaviorEntry>(
						calledFieldEntry,
						call.getFieldName(),
						behaviorEntry
					);
					m_fieldReferences.put(calledFieldEntry, reference);
				}
				
				@Override
				public void edit(ConstructorCall call) {
					ConstructorEntry calledConstructorEntry = JavassistUtil.getConstructorEntry(call);
					EntryReference<BehaviorEntry,BehaviorEntry> reference = new EntryReference<BehaviorEntry,BehaviorEntry>(
						calledConstructorEntry,
						call.getMethodName(),
						behaviorEntry
					);
					m_behaviorReferences.put(calledConstructorEntry, reference);
				}
				
				@Override
				public void edit(NewExpr call) {
					ConstructorEntry calledConstructorEntry = JavassistUtil.getConstructorEntry(call);
					EntryReference<BehaviorEntry,BehaviorEntry> reference = new EntryReference<BehaviorEntry,BehaviorEntry>(
						calledConstructorEntry,
						call.getClassName(),
						behaviorEntry
					);
					m_behaviorReferences.put(calledConstructorEntry, reference);
				}
			});
		} catch (CannotCompileException ex) {
			throw new Error(ex);
		}
	}
	
	private String findOuterClass(CtClass c) {
		
		// inner classes:
		// have constructors that can (illegally) set synthetic fields
		// the outer class is the only class that calls constructors
		
		// use the synthetic fields to find the synthetic constructors
		for (CtConstructor constructor : c.getDeclaredConstructors()) {
			Set<String> syntheticFieldTypes = Sets.newHashSet();
			if (!isIllegalConstructor(syntheticFieldTypes, constructor)) {
				continue;
			}
			
			ClassEntry classEntry = new ClassEntry(Descriptor.toJvmName(c.getName()));
			ConstructorEntry constructorEntry = JavassistUtil.getConstructorEntry(constructor);
			
			// gather the classes from the illegally-set synthetic fields
			Set<ClassEntry> illegallySetClasses = Sets.newHashSet();
			for (String type : syntheticFieldTypes) {
				if (type.startsWith("L")) {
					ClassEntry outerClassEntry = new ClassEntry(type.substring(1, type.length() - 1));
					if (isSaneOuterClass(outerClassEntry, classEntry)) {
						illegallySetClasses.add(outerClassEntry);
					}
				}
			}
			
			// who calls this constructor?
			Set<ClassEntry> callerClasses = Sets.newHashSet();
			for (EntryReference<BehaviorEntry,BehaviorEntry> reference : getBehaviorReferences(constructorEntry)) {
				
				// make sure it's not a call to super
				if (reference.entry instanceof ConstructorEntry && reference.context instanceof ConstructorEntry) {
					
					// is the entry a superclass of the context?
					ClassEntry calledClassEntry = reference.entry.getClassEntry();
					ClassEntry superclassEntry = m_translationIndex.getSuperclass(reference.context.getClassEntry());
					if (superclassEntry != null && superclassEntry.equals(calledClassEntry)) {
						// it's a super call, skip
						continue;
					}
				}
				
				if (isSaneOuterClass(reference.context.getClassEntry(), classEntry)) {
					callerClasses.add(reference.context.getClassEntry());
				}
			}
			
			// do we have an answer yet?
			if (callerClasses.isEmpty()) {
				if (illegallySetClasses.size() == 1) {
					return illegallySetClasses.iterator().next().getName();
				} else {
					System.out.println(String.format("WARNING: Unable to find outer class for %s. No caller and no illegally set field classes.", classEntry));
				}
			} else {
				if (callerClasses.size() == 1) {
					return callerClasses.iterator().next().getName();
				} else {
					// multiple callers, do the illegally set classes narrow it down?
					Set<ClassEntry> intersection = Sets.newHashSet(callerClasses);
					intersection.retainAll(illegallySetClasses);
					if (intersection.size() == 1) {
						return intersection.iterator().next().getName();
					} else {
						System.out.println(String.format("WARNING: Unable to choose outer class for %s among options: %s", classEntry, callerClasses));
					}
				}
			}
		}
		
		return null;
	}
	
	private boolean isSaneOuterClass(ClassEntry outerClassEntry, ClassEntry innerClassEntry) {
		
		// clearly this would be silly
		if (outerClassEntry.equals(innerClassEntry)) {
			return false;
		}
		
		// is the outer class in the jar?
		if (!m_obfClassEntries.contains(outerClassEntry)) {
			return false;
		}
		
		return true;
	}
	
	@SuppressWarnings("unchecked")
	private boolean isIllegalConstructor(Set<String> syntheticFieldTypes, CtConstructor constructor) {
		
		// illegal constructors only set synthetic member fields, then call super()
		String className = constructor.getDeclaringClass().getName();
		
		// collect all the field accesses, constructor calls, and method calls
		final List<FieldAccess> illegalFieldWrites = Lists.newArrayList();
		final List<ConstructorCall> constructorCalls = Lists.newArrayList();
		try {
			constructor.instrument(new ExprEditor() {
				@Override
				public void edit(FieldAccess fieldAccess) {
					if (fieldAccess.isWriter() && constructorCalls.isEmpty()) {
						illegalFieldWrites.add(fieldAccess);
					}
				}
				
				@Override
				public void edit(ConstructorCall constructorCall) {
					constructorCalls.add(constructorCall);
				}
			});
		} catch (CannotCompileException ex) {
			// we're not compiling anything... this is stupid
			throw new Error(ex);
		}
		
		// are there any illegal field writes?
		if (illegalFieldWrites.isEmpty()) {
			return false;
		}
		
		// are all the writes to synthetic fields?
		for (FieldAccess fieldWrite : illegalFieldWrites) {
			
			// all illegal writes have to be to the local class
			if (!fieldWrite.getClassName().equals(className)) {
				System.err.println(String.format("WARNING: illegal write to non-member field %s.%s", fieldWrite.getClassName(), fieldWrite.getFieldName()));
				return false;
			}
			
			// find the field
			FieldInfo fieldInfo = null;
			for (FieldInfo info : (List<FieldInfo>)constructor.getDeclaringClass().getClassFile().getFields()) {
				if (info.getName().equals(fieldWrite.getFieldName()) && info.getDescriptor().equals(fieldWrite.getSignature())) {
					fieldInfo = info;
					break;
				}
			}
			if (fieldInfo == null) {
				// field is in a superclass or something, can't be a local synthetic member
				return false;
			}
			
			// is this field synthetic?
			boolean isSynthetic = (fieldInfo.getAccessFlags() & AccessFlag.SYNTHETIC) != 0;
			if (isSynthetic) {
				syntheticFieldTypes.add(fieldInfo.getDescriptor());
			} else {
				System.err.println(String.format("WARNING: illegal write to non synthetic field %s %s.%s", fieldInfo.getDescriptor(), className, fieldInfo.getName()));
				return false;
			}
		}
		
		// we passed all the tests!
		return true;
	}
	
	private BehaviorEntry isAnonymousClass(CtClass c, String outerClassName) {
		
		ClassEntry innerClassEntry = new ClassEntry(Descriptor.toJvmName(c.getName()));
		
		// anonymous classes:
		// can't be abstract
		// have only one constructor
		// it's called exactly once by the outer class
		// the type the instance is assigned to can't be this type
		
		// is abstract?
		if (Modifier.isAbstract(c.getModifiers())) {
			return null;
		}
		
		// is there exactly one constructor?
		if (c.getDeclaredConstructors().length != 1) {
			return null;
		}
		CtConstructor constructor = c.getDeclaredConstructors()[0];
		
		// is this constructor called exactly once?
		ConstructorEntry constructorEntry = JavassistUtil.getConstructorEntry(constructor);
		Collection<EntryReference<BehaviorEntry,BehaviorEntry>> references = getBehaviorReferences(constructorEntry);
		if (references.size() != 1) {
			return null;
		}
		
		// does the caller use this type?
		BehaviorEntry caller = references.iterator().next().context;
		for (FieldEntry fieldEntry : getReferencedFields(caller)) {
			ClassEntry fieldClass = getFieldClass(fieldEntry);
			if (fieldClass != null && fieldClass.equals(innerClassEntry)) {
				// caller references this type, so it can't be anonymous
				return null;
			}
		}
		for (BehaviorEntry behaviorEntry : getReferencedBehaviors(caller)) {
			if (behaviorEntry.getSignature().hasClass(innerClassEntry)) {
				return null;
			}
		}
		
		return caller;
	}
	
	public Set<ClassEntry> getObfClassEntries() {
		return m_obfClassEntries;
	}
	
	public TranslationIndex getTranslationIndex() {
		return m_translationIndex;
	}
	
	public Access getAccess(Entry entry) {
		return m_access.get(entry);
	}
	
	public ClassEntry getFieldClass(FieldEntry fieldEntry) {
		return m_fieldClasses.get(fieldEntry);
	}
	
	public ClassInheritanceTreeNode getClassInheritance(Translator deobfuscatingTranslator, ClassEntry obfClassEntry) {
		
		// get the root node
		List<String> ancestry = Lists.newArrayList();
		ancestry.add(obfClassEntry.getName());
		for (ClassEntry classEntry : m_translationIndex.getAncestry(obfClassEntry)) {
			ancestry.add(classEntry.getName());
		}
		ClassInheritanceTreeNode rootNode = new ClassInheritanceTreeNode(
			deobfuscatingTranslator,
			ancestry.get(ancestry.size() - 1)
		);
		
		// expand all children recursively
		rootNode.load(m_translationIndex, true);
		
		return rootNode;
	}
	
	public ClassImplementationsTreeNode getClassImplementations(Translator deobfuscatingTranslator, ClassEntry obfClassEntry) {
		
		// is this even an interface?
		if (isInterface(obfClassEntry.getClassName())) {
			ClassImplementationsTreeNode node = new ClassImplementationsTreeNode(deobfuscatingTranslator, obfClassEntry);
			node.load(this);
			return node;
		}
		return null;
	}
	
	public MethodInheritanceTreeNode getMethodInheritance(Translator deobfuscatingTranslator, MethodEntry obfMethodEntry) {
		
		// travel to the ancestor implementation
		ClassEntry baseImplementationClassEntry = obfMethodEntry.getClassEntry();
		for (ClassEntry ancestorClassEntry : m_translationIndex.getAncestry(obfMethodEntry.getClassEntry())) {
			MethodEntry ancestorMethodEntry = new MethodEntry(
				new ClassEntry(ancestorClassEntry),
				obfMethodEntry.getName(),
				obfMethodEntry.getSignature()
			);
			if (containsObfBehavior(ancestorMethodEntry)) {
				baseImplementationClassEntry = ancestorClassEntry;
			}
		}
		
		// make a root node at the base
		MethodEntry methodEntry = new MethodEntry(
			baseImplementationClassEntry,
			obfMethodEntry.getName(),
			obfMethodEntry.getSignature()
		);
		MethodInheritanceTreeNode rootNode = new MethodInheritanceTreeNode(
			deobfuscatingTranslator,
			methodEntry,
			containsObfBehavior(methodEntry)
		);
		
		// expand the full tree
		rootNode.load(this, true);
		
		return rootNode;
	}
	
	public MethodImplementationsTreeNode getMethodImplementations(Translator deobfuscatingTranslator, MethodEntry obfMethodEntry) {
		
		MethodEntry interfaceMethodEntry;
		
		// is this method on an interface?
		if (isInterface(obfMethodEntry.getClassName())) {
			interfaceMethodEntry = obfMethodEntry;
		} else {
			// get the interface class
			List<MethodEntry> methodInterfaces = Lists.newArrayList();
			for (String interfaceName : getInterfaces(obfMethodEntry.getClassName())) {
				// is this method defined in this interface?
				MethodEntry methodInterface = new MethodEntry(
					new ClassEntry(interfaceName),
					obfMethodEntry.getName(),
					obfMethodEntry.getSignature()
				);
				if (containsObfBehavior(methodInterface)) {
					methodInterfaces.add(methodInterface);
				}
			}
			if (methodInterfaces.isEmpty()) {
				return null;
			}
			if (methodInterfaces.size() > 1) {
				throw new Error("Too many interfaces define this method! This is not yet supported by Enigma!");
			}
			interfaceMethodEntry = methodInterfaces.get(0);
		}
		
		MethodImplementationsTreeNode rootNode = new MethodImplementationsTreeNode(deobfuscatingTranslator, interfaceMethodEntry);
		rootNode.load(this);
		return rootNode;
	}
	
	public Set<MethodEntry> getRelatedMethodImplementations(MethodEntry obfMethodEntry) {
		Set<MethodEntry> methodEntries = Sets.newHashSet();
		getRelatedMethodImplementations(methodEntries, getMethodInheritance(null, obfMethodEntry));
		return methodEntries;
	}
	
	private void getRelatedMethodImplementations(Set<MethodEntry> methodEntries, MethodInheritanceTreeNode node) {
		MethodEntry methodEntry = node.getMethodEntry();
		if (containsObfBehavior(methodEntry)) {
			// collect the entry
			methodEntries.add(methodEntry);
		}
		
		// look at interface methods too
		MethodImplementationsTreeNode implementations = getMethodImplementations(null, methodEntry);
		if (implementations != null) {
			getRelatedMethodImplementations(methodEntries, implementations);
		}
		
		// recurse
		for (int i = 0; i < node.getChildCount(); i++) {
			getRelatedMethodImplementations(methodEntries, (MethodInheritanceTreeNode)node.getChildAt(i));
		}
	}
	
	private void getRelatedMethodImplementations(Set<MethodEntry> methodEntries, MethodImplementationsTreeNode node) {
		MethodEntry methodEntry = node.getMethodEntry();
		if (containsObfBehavior(methodEntry)) {
			// collect the entry
			methodEntries.add(methodEntry);
		}
		
		// recurse
		for (int i = 0; i < node.getChildCount(); i++) {
			getRelatedMethodImplementations(methodEntries, (MethodImplementationsTreeNode)node.getChildAt(i));
		}
	}
	
	public Collection<EntryReference<FieldEntry,BehaviorEntry>> getFieldReferences(FieldEntry fieldEntry) {
		return m_fieldReferences.get(fieldEntry);
	}
	
	public Collection<FieldEntry> getReferencedFields(BehaviorEntry behaviorEntry) {
		// linear search is fast enough for now
		Set<FieldEntry> fieldEntries = Sets.newHashSet();
		for (EntryReference<FieldEntry,BehaviorEntry> reference : m_fieldReferences.values()) {
			if (reference.context == behaviorEntry) {
				fieldEntries.add(reference.entry);
			}
		}
		return fieldEntries;
	}
	
	public Collection<EntryReference<BehaviorEntry,BehaviorEntry>> getBehaviorReferences(BehaviorEntry behaviorEntry) {
		return m_behaviorReferences.get(behaviorEntry);
	}
	
	public Collection<BehaviorEntry> getReferencedBehaviors(BehaviorEntry behaviorEntry) {
		// linear search is fast enough for now
		Set<BehaviorEntry> behaviorEntries = Sets.newHashSet();
		for (EntryReference<BehaviorEntry,BehaviorEntry> reference : m_behaviorReferences.values()) {
			if (reference.context == behaviorEntry) {
				behaviorEntries.add(reference.entry);
			}
		}
		return behaviorEntries;
	}
	
	public Collection<String> getInnerClasses(String obfOuterClassName) {
		return m_innerClasses.get(obfOuterClassName);
	}
	
	public String getOuterClass(String obfInnerClassName) {
		// make sure we use the right name
		if (new ClassEntry(obfInnerClassName).getPackageName() != null) {
			throw new IllegalArgumentException("Don't reference obfuscated inner classes using packages: " + obfInnerClassName);
		}
		return m_outerClasses.get(obfInnerClassName);
	}
	
	public boolean isAnonymousClass(String obfInnerClassName) {
		return m_anonymousClasses.containsKey(obfInnerClassName);
	}
	
	public BehaviorEntry getAnonymousClassCaller(String obfInnerClassName) {
		return m_anonymousClasses.get(obfInnerClassName);
	}
	
	public Set<String> getInterfaces(String className) {
		Set<String> interfaceNames = new HashSet<String>();
		interfaceNames.addAll(m_interfaces.get(className));
		for (ClassEntry ancestor : m_translationIndex.getAncestry(new ClassEntry(className))) {
			interfaceNames.addAll(m_interfaces.get(ancestor.getName()));
		}
		return interfaceNames;
	}
	
	public Set<String> getImplementingClasses(String targetInterfaceName) {
		// linear search is fast enough for now
		Set<String> classNames = Sets.newHashSet();
		for (Map.Entry<String,String> entry : m_interfaces.entries()) {
			String className = entry.getKey();
			String interfaceName = entry.getValue();
			if (interfaceName.equals(targetInterfaceName)) {
				classNames.add(className);
				m_translationIndex.getSubclassNamesRecursively(classNames, new ClassEntry(className));
			}
		}
		return classNames;
	}
	
	public boolean isInterface(String className) {
		return m_interfaces.containsValue(className);
	}
	
	public boolean containsObfClass(ClassEntry obfClassEntry) {
		return m_obfClassEntries.contains(obfClassEntry);
	}
	
	public boolean containsObfField(FieldEntry obfFieldEntry) {
		return m_access.containsKey(obfFieldEntry);
	}
	
	public boolean containsObfBehavior(BehaviorEntry obfBehaviorEntry) {
		return m_access.containsKey(obfBehaviorEntry);
	}
	
	public boolean containsObfArgument(ArgumentEntry obfArgumentEntry) {
		// check the behavior
		if (!containsObfBehavior(obfArgumentEntry.getBehaviorEntry())) {
			return false;
		}
		
		// check the argument
		if (obfArgumentEntry.getIndex() >= obfArgumentEntry.getBehaviorEntry().getSignature().getArgumentTypes().size()) {
			return false;
		}
		
		return true;
	}
	
	public boolean containsObfEntry(Entry obfEntry) {
		if (obfEntry instanceof ClassEntry) {
			return containsObfClass((ClassEntry)obfEntry);
		} else if (obfEntry instanceof FieldEntry) {
			return containsObfField((FieldEntry)obfEntry);
		} else if (obfEntry instanceof BehaviorEntry) {
			return containsObfBehavior((BehaviorEntry)obfEntry);
		} else if (obfEntry instanceof ArgumentEntry) {
			return containsObfArgument((ArgumentEntry)obfEntry);
		} else {
			throw new Error("Entry type not supported: " + obfEntry.getClass().getName());
		}
	}
}