Add out of bound check for Leader Key sequence array (#5840)

[qmk_firmware.git] / quantum / process_keycode / process_leader.c

diff --git a/quantum/process_keycode/process_leader.c b/quantum/process_keycode/process_leader.c
index 473906d65784c4a92e61e4f09938d36992e3a254..ee8099ca216024191b7c929b25da5336c614ec1d 100644 (file)
--- a/quantum/process_keycode/process_leader.c
+++ b/quantum/process_keycode/process_leader.c
@@ -14,7 +14,16 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#ifdef LEADER_ENABLE
+
 #include "process_leader.h"
+#ifdef __arm__
+#   include <string.h>
+#endif
+
+#ifndef LEADER_TIMEOUT
+  #define LEADER_TIMEOUT 300
+#endif
 
 __attribute__ ((weak))
 void leader_start(void) {}
@@ -29,26 +38,44 @@ uint16_t leader_time = 0;
 uint16_t leader_sequence[5] = {0, 0, 0, 0, 0};
 uint8_t leader_sequence_size = 0;
 
+void qk_leader_start(void) {
+  if (leading) { return; }
+  leader_start();
+  leading = true;
+  leader_time = timer_read();
+  leader_sequence_size = 0;
+  memset(leader_sequence, 0, sizeof(leader_sequence));
+}
+
 bool process_leader(uint16_t keycode, keyrecord_t *record) {
   // Leader key set-up
   if (record->event.pressed) {
-    if (!leading && keycode == KC_LEAD) {
-      leader_start();
-      leading = true;
-      leader_time = timer_read();
-      leader_sequence_size = 0;
-      leader_sequence[0] = 0;
-      leader_sequence[1] = 0;
-      leader_sequence[2] = 0;
-      leader_sequence[3] = 0;
-      leader_sequence[4] = 0;
-      return false;
-    }
-    if (leading && timer_elapsed(leader_time) < LEADER_TIMEOUT) {
-      leader_sequence[leader_sequence_size] = keycode;
-      leader_sequence_size++;
-      return false;
+    if (leading) {
+      if (timer_elapsed(leader_time) < LEADER_TIMEOUT) {
+#ifndef LEADER_KEY_STRICT_KEY_PROCESSING
+        if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX)) {
+          keycode = keycode & 0xFF;
+        }
+#endif // LEADER_KEY_STRICT_KEY_PROCESSING
+        if ( leader_sequence_size < ( sizeof(leader_sequence) / sizeof(leader_sequence[0]) ) ) {
+          leader_sequence[leader_sequence_size] = keycode;
+          leader_sequence_size++;
+        } else {
+          leading = false;
+          leader_end();
+        }
+#ifdef LEADER_PER_KEY_TIMING
+        leader_time = timer_read();
+#endif
+        return false;
+      }
+    } else {
+      if (keycode == KC_LEAD) {
+        qk_leader_start();
+      }
     }
   }
   return true;
 }
+
+#endif