@@ -24,131 +24,131 @@ |
||
24 | 24 | use OC\HintException; |
25 | 25 | |
26 | 26 | class ExceptionSerializer { |
27 | - const methodsWithSensitiveParameters = [ |
|
28 | - // Session/User |
|
29 | - 'completeLogin', |
|
30 | - 'login', |
|
31 | - 'checkPassword', |
|
32 | - 'checkPasswordNoLogging', |
|
33 | - 'loginWithPassword', |
|
34 | - 'updatePrivateKeyPassword', |
|
35 | - 'validateUserPass', |
|
36 | - 'loginWithToken', |
|
37 | - '{closure}', |
|
38 | - 'createSessionToken', |
|
39 | - |
|
40 | - // Provisioning |
|
41 | - 'addUser', |
|
42 | - |
|
43 | - // TokenProvider |
|
44 | - 'getToken', |
|
45 | - 'isTokenPassword', |
|
46 | - 'getPassword', |
|
47 | - 'decryptPassword', |
|
48 | - 'logClientIn', |
|
49 | - 'generateToken', |
|
50 | - 'validateToken', |
|
51 | - |
|
52 | - // TwoFactorAuth |
|
53 | - 'solveChallenge', |
|
54 | - 'verifyChallenge', |
|
55 | - |
|
56 | - // ICrypto |
|
57 | - 'calculateHMAC', |
|
58 | - 'encrypt', |
|
59 | - 'decrypt', |
|
60 | - |
|
61 | - // LoginController |
|
62 | - 'tryLogin', |
|
63 | - 'confirmPassword', |
|
64 | - |
|
65 | - // LDAP |
|
66 | - 'bind', |
|
67 | - 'areCredentialsValid', |
|
68 | - 'invokeLDAPMethod', |
|
69 | - |
|
70 | - // Encryption |
|
71 | - 'storeKeyPair', |
|
72 | - 'setupUser', |
|
73 | - |
|
74 | - // files_external: OC_Mount_Config |
|
75 | - 'getBackendStatus', |
|
76 | - |
|
77 | - // files_external: UserStoragesController |
|
78 | - 'update', |
|
79 | - ]; |
|
80 | - |
|
81 | - private function filterTrace(array $trace) { |
|
82 | - $sensitiveValues = []; |
|
83 | - $trace = array_map(function (array $traceLine) use (&$sensitiveValues) { |
|
84 | - foreach (self::methodsWithSensitiveParameters as $sensitiveMethod) { |
|
85 | - if (strpos($traceLine['function'], $sensitiveMethod) !== false) { |
|
86 | - $sensitiveValues = array_merge($sensitiveValues, $traceLine['args']); |
|
87 | - $traceLine['args'] = ['*** sensitive parameters replaced ***']; |
|
88 | - return $traceLine; |
|
89 | - } |
|
90 | - } |
|
91 | - return $traceLine; |
|
92 | - }, $trace); |
|
93 | - return array_map(function (array $traceLine) use ($sensitiveValues) { |
|
94 | - if (isset($traceLine['args'])) { |
|
95 | - $traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues); |
|
96 | - } |
|
97 | - return $traceLine; |
|
98 | - }, $trace); |
|
99 | - } |
|
100 | - |
|
101 | - private function removeValuesFromArgs($args, $values) { |
|
102 | - foreach ($args as &$arg) { |
|
103 | - if (in_array($arg, $values, true)) { |
|
104 | - $arg = '*** sensitive parameter replaced ***'; |
|
105 | - } else if (is_array($arg)) { |
|
106 | - $arg = $this->removeValuesFromArgs($arg, $values); |
|
107 | - } |
|
108 | - } |
|
109 | - return $args; |
|
110 | - } |
|
111 | - |
|
112 | - private function encodeTrace($trace) { |
|
113 | - $filteredTrace = $this->filterTrace($trace); |
|
114 | - return array_map(function (array $line) { |
|
115 | - if (isset($line['args'])) { |
|
116 | - $line['args'] = array_map([$this, 'encodeArg'], $line['args']); |
|
117 | - } |
|
118 | - return $line; |
|
119 | - }, $filteredTrace); |
|
120 | - } |
|
121 | - |
|
122 | - private function encodeArg($arg) { |
|
123 | - if (is_object($arg)) { |
|
124 | - $data = get_object_vars($arg); |
|
125 | - $data['__class__'] = get_class($arg); |
|
126 | - return array_map([$this, 'encodeArg'], $data); |
|
127 | - } else if (is_array($arg)) { |
|
128 | - return array_map([$this, 'encodeArg'], $arg); |
|
129 | - } else { |
|
130 | - return $arg; |
|
131 | - } |
|
132 | - } |
|
133 | - |
|
134 | - public function serializeException(\Throwable $exception) { |
|
135 | - $data = [ |
|
136 | - 'Exception' => get_class($exception), |
|
137 | - 'Message' => $exception->getMessage(), |
|
138 | - 'Code' => $exception->getCode(), |
|
139 | - 'Trace' => $this->encodeTrace($exception->getTrace()), |
|
140 | - 'File' => $exception->getFile(), |
|
141 | - 'Line' => $exception->getLine(), |
|
142 | - ]; |
|
143 | - |
|
144 | - if ($exception instanceof HintException) { |
|
145 | - $data['Hint'] = $exception->getHint(); |
|
146 | - } |
|
147 | - |
|
148 | - if ($exception->getPrevious()) { |
|
149 | - $data['Previous'] = $this->serializeException($exception->getPrevious()); |
|
150 | - } |
|
151 | - |
|
152 | - return $data; |
|
153 | - } |
|
27 | + const methodsWithSensitiveParameters = [ |
|
28 | + // Session/User |
|
29 | + 'completeLogin', |
|
30 | + 'login', |
|
31 | + 'checkPassword', |
|
32 | + 'checkPasswordNoLogging', |
|
33 | + 'loginWithPassword', |
|
34 | + 'updatePrivateKeyPassword', |
|
35 | + 'validateUserPass', |
|
36 | + 'loginWithToken', |
|
37 | + '{closure}', |
|
38 | + 'createSessionToken', |
|
39 | + |
|
40 | + // Provisioning |
|
41 | + 'addUser', |
|
42 | + |
|
43 | + // TokenProvider |
|
44 | + 'getToken', |
|
45 | + 'isTokenPassword', |
|
46 | + 'getPassword', |
|
47 | + 'decryptPassword', |
|
48 | + 'logClientIn', |
|
49 | + 'generateToken', |
|
50 | + 'validateToken', |
|
51 | + |
|
52 | + // TwoFactorAuth |
|
53 | + 'solveChallenge', |
|
54 | + 'verifyChallenge', |
|
55 | + |
|
56 | + // ICrypto |
|
57 | + 'calculateHMAC', |
|
58 | + 'encrypt', |
|
59 | + 'decrypt', |
|
60 | + |
|
61 | + // LoginController |
|
62 | + 'tryLogin', |
|
63 | + 'confirmPassword', |
|
64 | + |
|
65 | + // LDAP |
|
66 | + 'bind', |
|
67 | + 'areCredentialsValid', |
|
68 | + 'invokeLDAPMethod', |
|
69 | + |
|
70 | + // Encryption |
|
71 | + 'storeKeyPair', |
|
72 | + 'setupUser', |
|
73 | + |
|
74 | + // files_external: OC_Mount_Config |
|
75 | + 'getBackendStatus', |
|
76 | + |
|
77 | + // files_external: UserStoragesController |
|
78 | + 'update', |
|
79 | + ]; |
|
80 | + |
|
81 | + private function filterTrace(array $trace) { |
|
82 | + $sensitiveValues = []; |
|
83 | + $trace = array_map(function (array $traceLine) use (&$sensitiveValues) { |
|
84 | + foreach (self::methodsWithSensitiveParameters as $sensitiveMethod) { |
|
85 | + if (strpos($traceLine['function'], $sensitiveMethod) !== false) { |
|
86 | + $sensitiveValues = array_merge($sensitiveValues, $traceLine['args']); |
|
87 | + $traceLine['args'] = ['*** sensitive parameters replaced ***']; |
|
88 | + return $traceLine; |
|
89 | + } |
|
90 | + } |
|
91 | + return $traceLine; |
|
92 | + }, $trace); |
|
93 | + return array_map(function (array $traceLine) use ($sensitiveValues) { |
|
94 | + if (isset($traceLine['args'])) { |
|
95 | + $traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues); |
|
96 | + } |
|
97 | + return $traceLine; |
|
98 | + }, $trace); |
|
99 | + } |
|
100 | + |
|
101 | + private function removeValuesFromArgs($args, $values) { |
|
102 | + foreach ($args as &$arg) { |
|
103 | + if (in_array($arg, $values, true)) { |
|
104 | + $arg = '*** sensitive parameter replaced ***'; |
|
105 | + } else if (is_array($arg)) { |
|
106 | + $arg = $this->removeValuesFromArgs($arg, $values); |
|
107 | + } |
|
108 | + } |
|
109 | + return $args; |
|
110 | + } |
|
111 | + |
|
112 | + private function encodeTrace($trace) { |
|
113 | + $filteredTrace = $this->filterTrace($trace); |
|
114 | + return array_map(function (array $line) { |
|
115 | + if (isset($line['args'])) { |
|
116 | + $line['args'] = array_map([$this, 'encodeArg'], $line['args']); |
|
117 | + } |
|
118 | + return $line; |
|
119 | + }, $filteredTrace); |
|
120 | + } |
|
121 | + |
|
122 | + private function encodeArg($arg) { |
|
123 | + if (is_object($arg)) { |
|
124 | + $data = get_object_vars($arg); |
|
125 | + $data['__class__'] = get_class($arg); |
|
126 | + return array_map([$this, 'encodeArg'], $data); |
|
127 | + } else if (is_array($arg)) { |
|
128 | + return array_map([$this, 'encodeArg'], $arg); |
|
129 | + } else { |
|
130 | + return $arg; |
|
131 | + } |
|
132 | + } |
|
133 | + |
|
134 | + public function serializeException(\Throwable $exception) { |
|
135 | + $data = [ |
|
136 | + 'Exception' => get_class($exception), |
|
137 | + 'Message' => $exception->getMessage(), |
|
138 | + 'Code' => $exception->getCode(), |
|
139 | + 'Trace' => $this->encodeTrace($exception->getTrace()), |
|
140 | + 'File' => $exception->getFile(), |
|
141 | + 'Line' => $exception->getLine(), |
|
142 | + ]; |
|
143 | + |
|
144 | + if ($exception instanceof HintException) { |
|
145 | + $data['Hint'] = $exception->getHint(); |
|
146 | + } |
|
147 | + |
|
148 | + if ($exception->getPrevious()) { |
|
149 | + $data['Previous'] = $this->serializeException($exception->getPrevious()); |
|
150 | + } |
|
151 | + |
|
152 | + return $data; |
|
153 | + } |
|
154 | 154 | } |