public-transport/hafas-client

support new features

Open

#3 opened on Dec 18, 2017

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (60 forks)github user discovery
help wanted

Repository metrics

Stars
 (353 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Version 1.16 of the protocol, which let's us get a lot more information from the server, seems to use two mandatory query parameters called mic and mac.

I've recorded a few requests: https://gist.github.com/derhuerst/bf3caf8685b69c44f16f073402a59e32

Hypothesis: They are hashes of the request body, salted. Similar to how DB does it. Edit: see 6f958e1, 5ac8d5f & https://github.com/schildbach/public-transport-enabler/issues/187#issuecomment-357436079

Contributor guide

Research direction
Analyze the captured requests to reverse engineer the hashing algorithm for the mic and mac parameters. Compare with the existing implementation in DB's hafas client (see linked code). Implement the algorithm in the hafas client to support protocol version 1.16.
Tech stack
javascriptnodejs
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitJavaScriptHTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65