summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/Utils/HmacSerializer.php
blob: 80d560b612fcaf8184f5f247cabeee98a6f6adb0 (plain)
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
<?php

namespace SMW\Utils;

/**
 * Serialize/encode a data element with a hmac hash to verify that the output are
 * in fact the same as the input data, minimizing an attack vector on injecting
 * malicious content when retrieving the data from en external systems (like
 * a cache).
 *
 * The shared secret key to generate the HMAC is by default MediaWiki's
 * $wgSecretKey.
 *
 * @license GNU GPL v2+
 * @since 3.0
 *
 * @author mwjames
 */
class HmacSerializer {

	/**
	 * @since 3.0
	 *
	 * @param mixed $data
	 * @param string $key
	 * @param string $algo = 'md5'
	 *
	 * @return string|boolean
	 */
	public static function encode( $data, $key = null, $algo = 'md5' ) {

		if ( $key === null ) {
			$key = $GLOBALS['wgSecretKey'];
		}

		$data = json_encode( $data );
		$hash = hash_hmac( $algo, $data, $key );

		if ( $hash !== false ) {
			return json_encode( [ 'hmac' => $hash, 'data' => $data ] );
		}

		return false;
	}

	/**
	 * @since 3.0
	 *
	 * @param mixed $data
	 * @param string $key
	 * @param string $algo = 'md5'
	 *
	 * @return string|boolean
	 */
	public static function decode( $data, $key = null, $algo = 'md5' ) {

		if ( $key === null ) {
			$key = $GLOBALS['wgSecretKey'];
		}

		if ( !is_string( $data ) ) {
			return false;
		}

		$hash = '';
		$data = json_decode( $data, true );

		// Timing attack safe string comparison
		if ( isset( $data['hmac'] ) && hash_equals( hash_hmac( $algo, $data['data'], $key ), $data['hmac'] ) ) {
			return json_decode( $data['data'], true );
		}

		return false;
	}

	/**
	 * @since 3.0
	 *
	 * @param mixed $data
	 * @param string $key
	 * @param string $algo = 'md5'
	 *
	 * @return string|boolean
	 */
	public static function serialize( $data, $key = null, $algo = 'md5' ) {

		if ( $key === null ) {
			$key = $GLOBALS['wgSecretKey'];
		}

		$data = serialize( $data );
		$hash = hash_hmac( $algo, $data, $key );

		if ( $hash !== false ) {
			return "$hash|$data";
		}

		return false;
	}

	/**
	 * @since 3.0
	 *
	 * @param string $data
	 * @param string $key
	 * @param string $algo = 'md5'
	 *
	 * @return mixed|boolean
	 */
	public static function unserialize( $data, $key = null, $algo = 'md5' ) {

		if ( $key === null ) {
			$key = $GLOBALS['wgSecretKey'];
		}

		if ( !is_string( $data ) ) {
			return false;
		}

		$hash = '';

		if ( strpos( $data, '|' ) !== false ) {
			list( $hash, $data ) = explode( '|', $data, 2 );
		}

		// Timing attack safe string comparison
		if ( hash_equals( hash_hmac( $algo, $data, $key ), $hash ) ) {
			return unserialize( $data );
		}

		return false;
	}

	/**
	 * @since 3.0
	 *
	 * @param mixed $data
	 * @param string $key
	 * @param string $algo = 'md5'
	 *
	 * @return string|boolean
	 */
	public static function compress( $data, $key = null, $algo = 'md5' ) {

		if ( $key === null ) {
			$key = $GLOBALS['wgSecretKey'];
		}

		$key = $key . 'compress';

		return gzcompress( self::serialize( $data, $key, $algo ), 9 );
	}

	/**
	 * @since 3.0
	 *
	 * @param string $data
	 * @param string $key
	 * @param string $algo = 'md5'
	 *
	 * @return mixed|boolean
	 */
	public static function uncompress( $data, $key = null, $algo = 'md5' ) {

		if ( $key === null ) {
			$key = $GLOBALS['wgSecretKey'];
		}

		$key = $key . 'compress';

		return self::unserialize( @gzuncompress( $data ), $key, $algo );
	}

}